Interface operations

Hierarchy

  • operations

Properties

ArticleItems_GetArticleItems ArticleItems_GetOrderClasses Articles_DeleteArticleClass Articles_Get Articles_GetAll Articles_GetArticleClasses Articles_GetDangerousGoods Articles_GetDangerousGoodsByArticleNumber Articles_GetFiles Articles_GetHistoricalInventory Articles_GetInventoryPerWarehouse Articles_GetStructureRows Articles_GetStructureRowsByArticleNumber Articles_Post Articles_Put Articles_Put2 Articles_Put3 Articles_PutArticleClass Articles_PutArticleClassUsingId Articles_PutDangerousGoods Articles_PutDangerousGoodsByArticleNumber Articles_PutFileUsingFilename Articles_SetArticleClasses InventoryAdjustments_Get InventoryAdjustments_GetAll InventoryAdjustments_PatchInventoryAdjustmentArticlesReported Orders_Delete Orders_DeleteByOrderNumber Orders_DeleteParcel Orders_DeleteWayOfDeliveryType Orders_DeleteWaybillRow Orders_Get Orders_GetAll Orders_GetFiles Orders_GetInvoiceCharges Orders_GetOrderClasses Orders_GetOrderStatuses Orders_GetOrderTypes Orders_GetWayBillRows Orders_GetWayOfDeliveryTypes Orders_PatchAddOrderClasses Orders_PatchDeliveryDate Orders_PatchOrderNumber Orders_PatchOrderStatus Orders_PatchOrderTransporterCode Orders_PatchReportedNumberOfItems Orders_PatchReportedReturnedNumberOfItems Orders_PatchReturnWaybill Orders_PatchServicePointCode Orders_PatchSetOrderClasses Orders_PatchSetReportedNumberOfItemsToPickedNumberOfItems Orders_PatchSetReportedReturnedNumberOfItemsToReturnedNumberOfItems Orders_PatchWayBillRow Orders_PatchWaybill Orders_Post Orders_PostWayBillRow Orders_PutFile Orders_PutFileUsingFilename Orders_PutOrder Orders_PutOrderTracking Orders_PutOrderUsingOrderId Orders_PutParcel Orders_PutParcelUsingId Orders_PutWayOfDeliveryType Orders_PutWayOfDeliveryTypeUsingId ParcelTypes_GetParcelTypes PurchaseOrders_Delete PurchaseOrders_DeleteByOrderNumber PurchaseOrders_Get PurchaseOrders_GetAll PurchaseOrders_GetFiles PurchaseOrders_GetPurchaseOrderStatuses PurchaseOrders_GetPurchaseOrderTypes PurchaseOrders_PatchAdvisedDate PurchaseOrders_PatchFreeBool1 PurchaseOrders_PatchInDate PurchaseOrders_PatchReportedNumberOfItems PurchaseOrders_PatchSetReportedNumberOfItemsToReceivedNumberOfItems PurchaseOrders_PatchStatus PurchaseOrders_PostPurchaseOrderFile PurchaseOrders_Put PurchaseOrders_Put2 PurchaseOrders_PutArticleItems PurchaseOrders_PutFile PurchaseOrders_PutFileUsingFilename ReturnOrders_Get ReturnOrders_GetByReturnOrderId ReturnOrders_GetOrderStatuses ReturnOrders_GetReturnCauses ReturnOrders_PutReturnCause ReturnOrders_PutReturnCauseUsingId ReturnOrders_PutReturnOrder TransporterContracts_Get Warehouses_Get Warehouses_GetLocationTypes Warehouses_GetZonesForWarehouse

Properties

ArticleItems_GetArticleItems: {
    parameters: {
        query: {
            articleNumber?: null | string;
            articleNumbers?: null | string[];
            articleSystemIdFrom?: null | number;
            goodsOwnerId: number;
            locationNames?: null | string[];
            maxArticlesToGet?: null | number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    items?: null | {
                        batch?: null | string;
                        comment?: null | string;
                        container?: null | string;
                        expiryDate?: null | string;
                        inDate?: string;
                        isLocked?: boolean;
                        isLockedForSale?: boolean;
                        location?: null | string;
                        numberOfItems?: number;
                        serial?: null | string;
                        status?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    }[];
                }[];
            };
        };
    };
}

Get all article items which match the specified search criteria.

Type declaration

  • parameters: {
        query: {
            articleNumber?: null | string;
            articleNumbers?: null | string[];
            articleSystemIdFrom?: null | number;
            goodsOwnerId: number;
            locationNames?: null | string[];
            maxArticlesToGet?: null | number;
        };
    }
    • query: {
          articleNumber?: null | string;
          articleNumbers?: null | string[];
          articleSystemIdFrom?: null | number;
          goodsOwnerId: number;
          locationNames?: null | string[];
          maxArticlesToGet?: null | number;
      }
      • Optional articleNumber?: null | string

        Description

        Only return article items for this article number (only 1 article number may be specified).

      • Optional articleNumbers?: null | string[]

        Description

        Only return article items for these article numbers (several article numbers may be specified).

      • Optional articleSystemIdFrom?: null | number

        Description

        Only return articles whose article system ID is greater than or equal to this.

      • goodsOwnerId: number
      • Optional locationNames?: null | string[]

        Description

        Only return article items which are at these locations (several location names may be specified).

      • Optional maxArticlesToGet?: null | number

        Description

        Maximum number of articles to return.

  • responses: {
        200: {
            content: {
                application/json: null | {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    items?: null | {
                        batch?: null | string;
                        comment?: null | string;
                        container?: null | string;
                        expiryDate?: null | string;
                        inDate?: string;
                        isLocked?: boolean;
                        isLockedForSale?: boolean;
                        location?: null | string;
                        numberOfItems?: number;
                        serial?: null | string;
                        status?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    }[];
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  items?: null | {
                      batch?: null | string;
                      comment?: null | string;
                      container?: null | string;
                      expiryDate?: null | string;
                      inDate?: string;
                      isLocked?: boolean;
                      isLockedForSale?: boolean;
                      location?: null | string;
                      numberOfItems?: number;
                      serial?: null | string;
                      status?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      warehouse?: {
                          code?: null | string;
                          id?: number;
                          name?: null | string;
                      };
                  }[];
              }[];
          };
      }

      Description

      A list of article items, specified per article

      • content: {
            application/json: null | {
                articleNumber?: null | string;
                articleSystemId?: number;
                items?: null | {
                    batch?: null | string;
                    comment?: null | string;
                    container?: null | string;
                    expiryDate?: null | string;
                    inDate?: string;
                    isLocked?: boolean;
                    isLockedForSale?: boolean;
                    location?: null | string;
                    numberOfItems?: number;
                    serial?: null | string;
                    status?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                }[];
            }[];
        }
        • application/json: null | {
              articleNumber?: null | string;
              articleSystemId?: number;
              items?: null | {
                  batch?: null | string;
                  comment?: null | string;
                  container?: null | string;
                  expiryDate?: null | string;
                  inDate?: string;
                  isLocked?: boolean;
                  isLockedForSale?: boolean;
                  location?: null | string;
                  numberOfItems?: number;
                  serial?: null | string;
                  status?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
              }[];
          }[]
ArticleItems_GetOrderClasses: {
    parameters: {
        query: {
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleItemStatuses?: null | {
                        code?: null | string;
                        id?: number;
                        isLocked?: boolean;
                        isLockedForSale?: boolean;
                        name?: null | string;
                    }[];
                };
            };
        };
    };
}

Get all article item statuses.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
        };
    }
    • query: {
          goodsOwnerId: number;
      }
      • goodsOwnerId: number
  • responses: {
        200: {
            content: {
                application/json: {
                    articleItemStatuses?: null | {
                        code?: null | string;
                        id?: number;
                        isLocked?: boolean;
                        isLockedForSale?: boolean;
                        name?: null | string;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleItemStatuses?: null | {
                      code?: null | string;
                      id?: number;
                      isLocked?: boolean;
                      isLockedForSale?: boolean;
                      name?: null | string;
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                articleItemStatuses?: null | {
                    code?: null | string;
                    id?: number;
                    isLocked?: boolean;
                    isLockedForSale?: boolean;
                    name?: null | string;
                }[];
            };
        }
        • application/json: {
              articleItemStatuses?: null | {
                  code?: null | string;
                  id?: number;
                  isLocked?: boolean;
                  isLockedForSale?: boolean;
                  name?: null | string;
              }[];
          }
          • Optional articleItemStatuses?: null | {
                code?: null | string;
                id?: number;
                isLocked?: boolean;
                isLockedForSale?: boolean;
                name?: null | string;
            }[]
Articles_DeleteArticleClass: {
    parameters: {
        path: {
            articleClassId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleClassId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Delete an article class. This will affect any articles which have previously been assigned to the class.

Type declaration

  • parameters: {
        path: {
            articleClassId: number;
        };
    }
    • path: {
          articleClassId: number;
      }
      • articleClassId: number

        Description

        Article class ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    articleClassId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleClassId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                articleClassId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              articleClassId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional articleClassId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
Articles_Get: {
    parameters: {
        path: {
            articleSystemId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleCategory?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleDataLastUpdated?: null | string;
                    articleGroup?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleKind?: null | string;
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    barCodeInfo?: {
                        alternativeBarCodes?: null | {
                            barCode?: null | string;
                            barCodeType?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            quantityPerBarCode?: null | number;
                        }[];
                        barCode?: null | string;
                        barCodePackage?: null | string;
                        barCodePallet?: null | string;
                    };
                    classes?: null | {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    }[];
                    countryOfOriginCode?: null | string;
                    customerPrice?: null | number;
                    customsDescription?: null | string;
                    defaultLocation?: {
                        name?: null | string;
                    };
                    defaultLocationMaxNumberOfItems?: null | number;
                    defaultLocationStockLimit?: null | number;
                    description?: null | string;
                    freeValues?: {
                        freeBoolean1?: boolean;
                        freeBoolean2?: boolean;
                        freeBoolean3?: boolean;
                        freeDecimal1?: null | number;
                        freeDecimal2?: null | number;
                        freeDecimal3?: null | number;
                    };
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    height?: null | number;
                    inventoryInfo?: {
                        allocatedNumberOfItems?: number;
                        lastInDate?: null | string;
                        lockedForSaleNumberOfItems?: number;
                        numberOfBookedItems?: number;
                        numberOfItems?: number;
                        numberOfLockedItems?: number;
                        pickedToBeCollectedNumberOfItems?: number;
                        receivedToBeFinishedNumberOfItems?: number;
                        sellableNumberOfItems?: number;
                        toReceiveNumberOfItems?: number;
                        totalStockValue?: number;
                    };
                    isActive?: null | boolean;
                    isStockArticle?: null | boolean;
                    length?: null | number;
                    linkToPicture?: null | string;
                    minimumReorderQuantity?: null | number;
                    netWeight?: null | number;
                    productCode?: null | string;
                    purcaseCurrencyCode?: null | string;
                    purchasePrice?: null | number;
                    quantityPerPackage?: null | number;
                    quantityPerPallet?: null | number;
                    statisticsNumber?: null | string;
                    stockLimit?: null | number;
                    stockValuationPrice?: null | number;
                    storageProperties?: {
                        isObsolete?: boolean;
                    };
                    subQuantityPerItem?: null | number;
                    supplierInfo?: {
                        alternativeSuppliers?: null | {
                            supplierArticleNumber?: null | string;
                            supplierName?: null | string;
                            supplierNumber?: null | string;
                        }[];
                        supplierArticleNumber?: null | string;
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    };
                    taricNumbersInfo?: {
                        taricNumbers?: null | {
                            countryCode?: null | string;
                            taricNumber?: null | string;
                        }[];
                    };
                    unitCode?: null | string;
                    volume?: null | number;
                    weight?: null | number;
                    width?: null | number;
                };
            };
        };
    };
}

Get an article.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
        };
    }
    • path: {
          articleSystemId: number;
      }
      • articleSystemId: number

        Description

        Article system ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    articleCategory?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleDataLastUpdated?: null | string;
                    articleGroup?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleKind?: null | string;
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    barCodeInfo?: {
                        alternativeBarCodes?: null | {
                            barCode?: null | string;
                            barCodeType?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            quantityPerBarCode?: null | number;
                        }[];
                        barCode?: null | string;
                        barCodePackage?: null | string;
                        barCodePallet?: null | string;
                    };
                    classes?: null | {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    }[];
                    countryOfOriginCode?: null | string;
                    customerPrice?: null | number;
                    customsDescription?: null | string;
                    defaultLocation?: {
                        name?: null | string;
                    };
                    defaultLocationMaxNumberOfItems?: null | number;
                    defaultLocationStockLimit?: null | number;
                    description?: null | string;
                    freeValues?: {
                        freeBoolean1?: boolean;
                        freeBoolean2?: boolean;
                        freeBoolean3?: boolean;
                        freeDecimal1?: null | number;
                        freeDecimal2?: null | number;
                        freeDecimal3?: null | number;
                    };
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    height?: null | number;
                    inventoryInfo?: {
                        allocatedNumberOfItems?: number;
                        lastInDate?: null | string;
                        lockedForSaleNumberOfItems?: number;
                        numberOfBookedItems?: number;
                        numberOfItems?: number;
                        numberOfLockedItems?: number;
                        pickedToBeCollectedNumberOfItems?: number;
                        receivedToBeFinishedNumberOfItems?: number;
                        sellableNumberOfItems?: number;
                        toReceiveNumberOfItems?: number;
                        totalStockValue?: number;
                    };
                    isActive?: null | boolean;
                    isStockArticle?: null | boolean;
                    length?: null | number;
                    linkToPicture?: null | string;
                    minimumReorderQuantity?: null | number;
                    netWeight?: null | number;
                    productCode?: null | string;
                    purcaseCurrencyCode?: null | string;
                    purchasePrice?: null | number;
                    quantityPerPackage?: null | number;
                    quantityPerPallet?: null | number;
                    statisticsNumber?: null | string;
                    stockLimit?: null | number;
                    stockValuationPrice?: null | number;
                    storageProperties?: {
                        isObsolete?: boolean;
                    };
                    subQuantityPerItem?: null | number;
                    supplierInfo?: {
                        alternativeSuppliers?: null | {
                            supplierArticleNumber?: null | string;
                            supplierName?: null | string;
                            supplierNumber?: null | string;
                        }[];
                        supplierArticleNumber?: null | string;
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    };
                    taricNumbersInfo?: {
                        taricNumbers?: null | {
                            countryCode?: null | string;
                            taricNumber?: null | string;
                        }[];
                    };
                    unitCode?: null | string;
                    volume?: null | number;
                    weight?: null | number;
                    width?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleCategory?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  articleDataLastUpdated?: null | string;
                  articleGroup?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  articleKind?: null | string;
                  articleName?: null | string;
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  barCodeInfo?: {
                      alternativeBarCodes?: null | {
                          barCode?: null | string;
                          barCodeType?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          quantityPerBarCode?: null | number;
                      }[];
                      barCode?: null | string;
                      barCodePackage?: null | string;
                      barCodePallet?: null | string;
                  };
                  classes?: null | {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  }[];
                  countryOfOriginCode?: null | string;
                  customerPrice?: null | number;
                  customsDescription?: null | string;
                  defaultLocation?: {
                      name?: null | string;
                  };
                  defaultLocationMaxNumberOfItems?: null | number;
                  defaultLocationStockLimit?: null | number;
                  description?: null | string;
                  freeValues?: {
                      freeBoolean1?: boolean;
                      freeBoolean2?: boolean;
                      freeBoolean3?: boolean;
                      freeDecimal1?: null | number;
                      freeDecimal2?: null | number;
                      freeDecimal3?: null | number;
                  };
                  goodsOwner?: {
                      id?: number;
                      name?: null | string;
                  };
                  height?: null | number;
                  inventoryInfo?: {
                      allocatedNumberOfItems?: number;
                      lastInDate?: null | string;
                      lockedForSaleNumberOfItems?: number;
                      numberOfBookedItems?: number;
                      numberOfItems?: number;
                      numberOfLockedItems?: number;
                      pickedToBeCollectedNumberOfItems?: number;
                      receivedToBeFinishedNumberOfItems?: number;
                      sellableNumberOfItems?: number;
                      toReceiveNumberOfItems?: number;
                      totalStockValue?: number;
                  };
                  isActive?: null | boolean;
                  isStockArticle?: null | boolean;
                  length?: null | number;
                  linkToPicture?: null | string;
                  minimumReorderQuantity?: null | number;
                  netWeight?: null | number;
                  productCode?: null | string;
                  purcaseCurrencyCode?: null | string;
                  purchasePrice?: null | number;
                  quantityPerPackage?: null | number;
                  quantityPerPallet?: null | number;
                  statisticsNumber?: null | string;
                  stockLimit?: null | number;
                  stockValuationPrice?: null | number;
                  storageProperties?: {
                      isObsolete?: boolean;
                  };
                  subQuantityPerItem?: null | number;
                  supplierInfo?: {
                      alternativeSuppliers?: null | {
                          supplierArticleNumber?: null | string;
                          supplierName?: null | string;
                          supplierNumber?: null | string;
                      }[];
                      supplierArticleNumber?: null | string;
                      supplierName?: null | string;
                      supplierNumber?: null | string;
                  };
                  taricNumbersInfo?: {
                      taricNumbers?: null | {
                          countryCode?: null | string;
                          taricNumber?: null | string;
                      }[];
                  };
                  unitCode?: null | string;
                  volume?: null | number;
                  weight?: null | number;
                  width?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                articleCategory?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleDataLastUpdated?: null | string;
                articleGroup?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleKind?: null | string;
                articleName?: null | string;
                articleNumber?: null | string;
                articleSystemId?: number;
                barCodeInfo?: {
                    alternativeBarCodes?: null | {
                        barCode?: null | string;
                        barCodeType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        quantityPerBarCode?: null | number;
                    }[];
                    barCode?: null | string;
                    barCodePackage?: null | string;
                    barCodePallet?: null | string;
                };
                classes?: null | {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                }[];
                countryOfOriginCode?: null | string;
                customerPrice?: null | number;
                customsDescription?: null | string;
                defaultLocation?: {
                    name?: null | string;
                };
                defaultLocationMaxNumberOfItems?: null | number;
                defaultLocationStockLimit?: null | number;
                description?: null | string;
                freeValues?: {
                    freeBoolean1?: boolean;
                    freeBoolean2?: boolean;
                    freeBoolean3?: boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeDecimal3?: null | number;
                };
                goodsOwner?: {
                    id?: number;
                    name?: null | string;
                };
                height?: null | number;
                inventoryInfo?: {
                    allocatedNumberOfItems?: number;
                    lastInDate?: null | string;
                    lockedForSaleNumberOfItems?: number;
                    numberOfBookedItems?: number;
                    numberOfItems?: number;
                    numberOfLockedItems?: number;
                    pickedToBeCollectedNumberOfItems?: number;
                    receivedToBeFinishedNumberOfItems?: number;
                    sellableNumberOfItems?: number;
                    toReceiveNumberOfItems?: number;
                    totalStockValue?: number;
                };
                isActive?: null | boolean;
                isStockArticle?: null | boolean;
                length?: null | number;
                linkToPicture?: null | string;
                minimumReorderQuantity?: null | number;
                netWeight?: null | number;
                productCode?: null | string;
                purcaseCurrencyCode?: null | string;
                purchasePrice?: null | number;
                quantityPerPackage?: null | number;
                quantityPerPallet?: null | number;
                statisticsNumber?: null | string;
                stockLimit?: null | number;
                stockValuationPrice?: null | number;
                storageProperties?: {
                    isObsolete?: boolean;
                };
                subQuantityPerItem?: null | number;
                supplierInfo?: {
                    alternativeSuppliers?: null | {
                        supplierArticleNumber?: null | string;
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    }[];
                    supplierArticleNumber?: null | string;
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                taricNumbersInfo?: {
                    taricNumbers?: null | {
                        countryCode?: null | string;
                        taricNumber?: null | string;
                    }[];
                };
                unitCode?: null | string;
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            };
        }
        • application/json: {
              articleCategory?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleDataLastUpdated?: null | string;
              articleGroup?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleKind?: null | string;
              articleName?: null | string;
              articleNumber?: null | string;
              articleSystemId?: number;
              barCodeInfo?: {
                  alternativeBarCodes?: null | {
                      barCode?: null | string;
                      barCodeType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      quantityPerBarCode?: null | number;
                  }[];
                  barCode?: null | string;
                  barCodePackage?: null | string;
                  barCodePallet?: null | string;
              };
              classes?: null | {
                  code?: null | string;
                  id?: number;
                  name?: null | string;
              }[];
              countryOfOriginCode?: null | string;
              customerPrice?: null | number;
              customsDescription?: null | string;
              defaultLocation?: {
                  name?: null | string;
              };
              defaultLocationMaxNumberOfItems?: null | number;
              defaultLocationStockLimit?: null | number;
              description?: null | string;
              freeValues?: {
                  freeBoolean1?: boolean;
                  freeBoolean2?: boolean;
                  freeBoolean3?: boolean;
                  freeDecimal1?: null | number;
                  freeDecimal2?: null | number;
                  freeDecimal3?: null | number;
              };
              goodsOwner?: {
                  id?: number;
                  name?: null | string;
              };
              height?: null | number;
              inventoryInfo?: {
                  allocatedNumberOfItems?: number;
                  lastInDate?: null | string;
                  lockedForSaleNumberOfItems?: number;
                  numberOfBookedItems?: number;
                  numberOfItems?: number;
                  numberOfLockedItems?: number;
                  pickedToBeCollectedNumberOfItems?: number;
                  receivedToBeFinishedNumberOfItems?: number;
                  sellableNumberOfItems?: number;
                  toReceiveNumberOfItems?: number;
                  totalStockValue?: number;
              };
              isActive?: null | boolean;
              isStockArticle?: null | boolean;
              length?: null | number;
              linkToPicture?: null | string;
              minimumReorderQuantity?: null | number;
              netWeight?: null | number;
              productCode?: null | string;
              purcaseCurrencyCode?: null | string;
              purchasePrice?: null | number;
              quantityPerPackage?: null | number;
              quantityPerPallet?: null | number;
              statisticsNumber?: null | string;
              stockLimit?: null | number;
              stockValuationPrice?: null | number;
              storageProperties?: {
                  isObsolete?: boolean;
              };
              subQuantityPerItem?: null | number;
              supplierInfo?: {
                  alternativeSuppliers?: null | {
                      supplierArticleNumber?: null | string;
                      supplierName?: null | string;
                      supplierNumber?: null | string;
                  }[];
                  supplierArticleNumber?: null | string;
                  supplierName?: null | string;
                  supplierNumber?: null | string;
              };
              taricNumbersInfo?: {
                  taricNumbers?: null | {
                      countryCode?: null | string;
                      taricNumber?: null | string;
                  }[];
              };
              unitCode?: null | string;
              volume?: null | number;
              weight?: null | number;
              width?: null | number;
          }
          • Optional articleCategory?: {
                code?: null | string;
                name?: null | string;
            }
            • Optional code?: null | string
            • Optional name?: null | string
          • Optional articleDataLastUpdated?: null | string

            Format: date-time

          • Optional articleGroup?: {
                code?: null | string;
                name?: null | string;
            }
            • Optional code?: null | string
            • Optional name?: null | string
          • Optional articleKind?: null | string
          • Optional articleName?: null | string
          • Optional articleNumber?: null | string
          • Optional articleSystemId?: number

            Format: int32

          • Optional barCodeInfo?: {
                alternativeBarCodes?: null | {
                    barCode?: null | string;
                    barCodeType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    quantityPerBarCode?: null | number;
                }[];
                barCode?: null | string;
                barCodePackage?: null | string;
                barCodePallet?: null | string;
            }
            • Optional alternativeBarCodes?: null | {
                  barCode?: null | string;
                  barCodeType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  quantityPerBarCode?: null | number;
              }[]
            • Optional barCode?: null | string
            • Optional barCodePackage?: null | string
            • Optional barCodePallet?: null | string
          • Optional classes?: null | {
                code?: null | string;
                id?: number;
                name?: null | string;
            }[]
          • Optional countryOfOriginCode?: null | string
          • Optional customerPrice?: null | number

            Format: decimal

          • Optional customsDescription?: null | string
          • Optional defaultLocation?: {
                name?: null | string;
            }
            • Optional name?: null | string
          • Optional defaultLocationMaxNumberOfItems?: null | number

            Format: decimal

          • Optional defaultLocationStockLimit?: null | number

            Format: decimal

          • Optional description?: null | string
          • Optional freeValues?: {
                freeBoolean1?: boolean;
                freeBoolean2?: boolean;
                freeBoolean3?: boolean;
                freeDecimal1?: null | number;
                freeDecimal2?: null | number;
                freeDecimal3?: null | number;
            }
            • Optional freeBoolean1?: boolean
            • Optional freeBoolean2?: boolean
            • Optional freeBoolean3?: boolean
            • Optional freeDecimal1?: null | number

              Format: decimal

            • Optional freeDecimal2?: null | number

              Format: decimal

            • Optional freeDecimal3?: null | number

              Format: decimal

          • Optional goodsOwner?: {
                id?: number;
                name?: null | string;
            }

            Description

            Goods owner.

            • Optional id?: number

              Format: int32

            • Optional name?: null | string
          • Optional height?: null | number

            Format: decimal

          • Optional inventoryInfo?: {
                allocatedNumberOfItems?: number;
                lastInDate?: null | string;
                lockedForSaleNumberOfItems?: number;
                numberOfBookedItems?: number;
                numberOfItems?: number;
                numberOfLockedItems?: number;
                pickedToBeCollectedNumberOfItems?: number;
                receivedToBeFinishedNumberOfItems?: number;
                sellableNumberOfItems?: number;
                toReceiveNumberOfItems?: number;
                totalStockValue?: number;
            }
            • Optional allocatedNumberOfItems?: number

              Format: decimal

            • Optional lastInDate?: null | string

              Format: date-time

            • Optional lockedForSaleNumberOfItems?: number

              Format: decimal

            • Optional numberOfBookedItems?: number

              Format: decimal

            • Optional numberOfItems?: number

              Format: decimal

            • Optional numberOfLockedItems?: number

              Format: decimal

            • Optional pickedToBeCollectedNumberOfItems?: number

              Format: decimal

            • Optional receivedToBeFinishedNumberOfItems?: number

              Format: decimal

            • Optional sellableNumberOfItems?: number

              Format: decimal

            • Optional toReceiveNumberOfItems?: number

              Format: decimal

            • Optional totalStockValue?: number

              Format: decimal

          • Optional isActive?: null | boolean
          • Optional isStockArticle?: null | boolean
          • Optional length?: null | number

            Format: decimal

          • Optional linkToPicture?: null | string
          • Optional minimumReorderQuantity?: null | number

            Format: decimal

          • Optional netWeight?: null | number

            Format: decimal

          • Optional productCode?: null | string
          • Optional purcaseCurrencyCode?: null | string
          • Optional purchasePrice?: null | number

            Format: decimal

          • Optional quantityPerPackage?: null | number

            Format: int32

          • Optional quantityPerPallet?: null | number

            Format: int32

          • Optional statisticsNumber?: null | string
          • Optional stockLimit?: null | number

            Format: int32

          • Optional stockValuationPrice?: null | number

            Format: decimal

          • Optional storageProperties?: {
                isObsolete?: boolean;
            }
            • Optional isObsolete?: boolean
          • Optional subQuantityPerItem?: null | number

            Format: decimal

          • Optional supplierInfo?: {
                alternativeSuppliers?: null | {
                    supplierArticleNumber?: null | string;
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                }[];
                supplierArticleNumber?: null | string;
                supplierName?: null | string;
                supplierNumber?: null | string;
            }
            • Optional alternativeSuppliers?: null | {
                  supplierArticleNumber?: null | string;
                  supplierName?: null | string;
                  supplierNumber?: null | string;
              }[]
            • Optional supplierArticleNumber?: null | string
            • Optional supplierName?: null | string
            • Optional supplierNumber?: null | string
          • Optional taricNumbersInfo?: {
                taricNumbers?: null | {
                    countryCode?: null | string;
                    taricNumber?: null | string;
                }[];
            }
            • Optional taricNumbers?: null | {
                  countryCode?: null | string;
                  taricNumber?: null | string;
              }[]
          • Optional unitCode?: null | string
          • Optional volume?: null | number

            Format: decimal

          • Optional weight?: null | number

            Format: decimal

          • Optional width?: null | number

            Format: decimal

Articles_GetAll: {
    parameters: {
        query: {
            articleClassIds?: null | number[];
            articleDataLastUpdatedFrom?: null | string;
            articleNameContains?: null | string[];
            articleNumber?: null | string;
            articleNumbers?: null | string[];
            articleSystemIdFrom?: null | number;
            barCodes?: null | string[];
            goodsOwnerId: number;
            maxArticlesToGet?: null | number;
            onlyArticlesBelowStockLimit?: null | boolean;
            onlyArticlesBelowStockLimitConsideringNumberOfBookedItems?: null | boolean;
            onlyArticlesInStock?: null | boolean;
            productCode?: null | string;
            productCodes?: null | string[];
            stockInfoChangedFrom?: null | string;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    articleCategory?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleDataLastUpdated?: null | string;
                    articleGroup?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleKind?: null | string;
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    barCodeInfo?: {
                        alternativeBarCodes?: null | {
                            barCode?: null | string;
                            barCodeType?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            quantityPerBarCode?: null | number;
                        }[];
                        barCode?: null | string;
                        barCodePackage?: null | string;
                        barCodePallet?: null | string;
                    };
                    classes?: null | {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    }[];
                    countryOfOriginCode?: null | string;
                    customerPrice?: null | number;
                    customsDescription?: null | string;
                    defaultLocation?: {
                        name?: null | string;
                    };
                    defaultLocationMaxNumberOfItems?: null | number;
                    defaultLocationStockLimit?: null | number;
                    description?: null | string;
                    freeValues?: {
                        freeBoolean1?: boolean;
                        freeBoolean2?: boolean;
                        freeBoolean3?: boolean;
                        freeDecimal1?: null | number;
                        freeDecimal2?: null | number;
                        freeDecimal3?: null | number;
                    };
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    height?: null | number;
                    inventoryInfo?: {
                        allocatedNumberOfItems?: number;
                        lastInDate?: null | string;
                        lockedForSaleNumberOfItems?: number;
                        numberOfBookedItems?: number;
                        numberOfItems?: number;
                        numberOfLockedItems?: number;
                        pickedToBeCollectedNumberOfItems?: number;
                        receivedToBeFinishedNumberOfItems?: number;
                        sellableNumberOfItems?: number;
                        toReceiveNumberOfItems?: number;
                        totalStockValue?: number;
                    };
                    isActive?: null | boolean;
                    isStockArticle?: null | boolean;
                    length?: null | number;
                    linkToPicture?: null | string;
                    minimumReorderQuantity?: null | number;
                    netWeight?: null | number;
                    productCode?: null | string;
                    purcaseCurrencyCode?: null | string;
                    purchasePrice?: null | number;
                    quantityPerPackage?: null | number;
                    quantityPerPallet?: null | number;
                    statisticsNumber?: null | string;
                    stockLimit?: null | number;
                    stockValuationPrice?: null | number;
                    storageProperties?: {
                        isObsolete?: boolean;
                    };
                    subQuantityPerItem?: null | number;
                    supplierInfo?: {
                        alternativeSuppliers?: null | {
                            supplierArticleNumber?: null | string;
                            supplierName?: null | string;
                            supplierNumber?: null | string;
                        }[];
                        supplierArticleNumber?: null | string;
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    };
                    taricNumbersInfo?: {
                        taricNumbers?: null | {
                            countryCode?: null | string;
                            taricNumber?: null | string;
                        }[];
                    };
                    unitCode?: null | string;
                    volume?: null | number;
                    weight?: null | number;
                    width?: null | number;
                }[];
            };
        };
    };
}

Get all articles which match the specified search criteria.

Type declaration

  • parameters: {
        query: {
            articleClassIds?: null | number[];
            articleDataLastUpdatedFrom?: null | string;
            articleNameContains?: null | string[];
            articleNumber?: null | string;
            articleNumbers?: null | string[];
            articleSystemIdFrom?: null | number;
            barCodes?: null | string[];
            goodsOwnerId: number;
            maxArticlesToGet?: null | number;
            onlyArticlesBelowStockLimit?: null | boolean;
            onlyArticlesBelowStockLimitConsideringNumberOfBookedItems?: null | boolean;
            onlyArticlesInStock?: null | boolean;
            productCode?: null | string;
            productCodes?: null | string[];
            stockInfoChangedFrom?: null | string;
        };
    }
    • query: {
          articleClassIds?: null | number[];
          articleDataLastUpdatedFrom?: null | string;
          articleNameContains?: null | string[];
          articleNumber?: null | string;
          articleNumbers?: null | string[];
          articleSystemIdFrom?: null | number;
          barCodes?: null | string[];
          goodsOwnerId: number;
          maxArticlesToGet?: null | number;
          onlyArticlesBelowStockLimit?: null | boolean;
          onlyArticlesBelowStockLimitConsideringNumberOfBookedItems?: null | boolean;
          onlyArticlesInStock?: null | boolean;
          productCode?: null | string;
          productCodes?: null | string[];
          stockInfoChangedFrom?: null | string;
      }
      • Optional articleClassIds?: null | number[]

        Description

        Only return articles of these article classes.

      • Optional articleDataLastUpdatedFrom?: null | string

        Description

        Only return articles where the article data has changed after this time.

      • Optional articleNameContains?: null | string[]
      • Optional articleNumber?: null | string

        Description

        Article number.

      • Optional articleNumbers?: null | string[]
      • Optional articleSystemIdFrom?: null | number

        Description

        Only return articles whose article system ID is greater than or equal to this.

      • Optional barCodes?: null | string[]
      • goodsOwnerId: number

        Description

        Goods owner ID.

      • Optional maxArticlesToGet?: null | number

        Description

        Maximum number of articles to return.

      • Optional onlyArticlesBelowStockLimit?: null | boolean

        Description

        Only return articles whose physical quantity is below the stock limit.

      • Optional onlyArticlesBelowStockLimitConsideringNumberOfBookedItems?: null | boolean

        Description

        Only return articles which have "physical quantity minus booked quantity" below the stock limit.

      • Optional onlyArticlesInStock?: null | boolean

        Description

        Only return articles where which are actually in stock (i.e. those articles having numberOfItems > 0).

      • Optional productCode?: null | string

        Description

        Product code.

      • Optional productCodes?: null | string[]
      • Optional stockInfoChangedFrom?: null | string

        Description

        Only return articles where the stock balances have changed after this time. NOTE: this value must must be within 24 hours of the current time.

  • responses: {
        200: {
            content: {
                application/json: null | {
                    articleCategory?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleDataLastUpdated?: null | string;
                    articleGroup?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleKind?: null | string;
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    barCodeInfo?: {
                        alternativeBarCodes?: null | {
                            barCode?: null | string;
                            barCodeType?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            quantityPerBarCode?: null | number;
                        }[];
                        barCode?: null | string;
                        barCodePackage?: null | string;
                        barCodePallet?: null | string;
                    };
                    classes?: null | {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    }[];
                    countryOfOriginCode?: null | string;
                    customerPrice?: null | number;
                    customsDescription?: null | string;
                    defaultLocation?: {
                        name?: null | string;
                    };
                    defaultLocationMaxNumberOfItems?: null | number;
                    defaultLocationStockLimit?: null | number;
                    description?: null | string;
                    freeValues?: {
                        freeBoolean1?: boolean;
                        freeBoolean2?: boolean;
                        freeBoolean3?: boolean;
                        freeDecimal1?: null | number;
                        freeDecimal2?: null | number;
                        freeDecimal3?: null | number;
                    };
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    height?: null | number;
                    inventoryInfo?: {
                        allocatedNumberOfItems?: number;
                        lastInDate?: null | string;
                        lockedForSaleNumberOfItems?: number;
                        numberOfBookedItems?: number;
                        numberOfItems?: number;
                        numberOfLockedItems?: number;
                        pickedToBeCollectedNumberOfItems?: number;
                        receivedToBeFinishedNumberOfItems?: number;
                        sellableNumberOfItems?: number;
                        toReceiveNumberOfItems?: number;
                        totalStockValue?: number;
                    };
                    isActive?: null | boolean;
                    isStockArticle?: null | boolean;
                    length?: null | number;
                    linkToPicture?: null | string;
                    minimumReorderQuantity?: null | number;
                    netWeight?: null | number;
                    productCode?: null | string;
                    purcaseCurrencyCode?: null | string;
                    purchasePrice?: null | number;
                    quantityPerPackage?: null | number;
                    quantityPerPallet?: null | number;
                    statisticsNumber?: null | string;
                    stockLimit?: null | number;
                    stockValuationPrice?: null | number;
                    storageProperties?: {
                        isObsolete?: boolean;
                    };
                    subQuantityPerItem?: null | number;
                    supplierInfo?: {
                        alternativeSuppliers?: null | {
                            supplierArticleNumber?: null | string;
                            supplierName?: null | string;
                            supplierNumber?: null | string;
                        }[];
                        supplierArticleNumber?: null | string;
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    };
                    taricNumbersInfo?: {
                        taricNumbers?: null | {
                            countryCode?: null | string;
                            taricNumber?: null | string;
                        }[];
                    };
                    unitCode?: null | string;
                    volume?: null | number;
                    weight?: null | number;
                    width?: null | number;
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  articleCategory?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  articleDataLastUpdated?: null | string;
                  articleGroup?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  articleKind?: null | string;
                  articleName?: null | string;
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  barCodeInfo?: {
                      alternativeBarCodes?: null | {
                          barCode?: null | string;
                          barCodeType?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          quantityPerBarCode?: null | number;
                      }[];
                      barCode?: null | string;
                      barCodePackage?: null | string;
                      barCodePallet?: null | string;
                  };
                  classes?: null | {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  }[];
                  countryOfOriginCode?: null | string;
                  customerPrice?: null | number;
                  customsDescription?: null | string;
                  defaultLocation?: {
                      name?: null | string;
                  };
                  defaultLocationMaxNumberOfItems?: null | number;
                  defaultLocationStockLimit?: null | number;
                  description?: null | string;
                  freeValues?: {
                      freeBoolean1?: boolean;
                      freeBoolean2?: boolean;
                      freeBoolean3?: boolean;
                      freeDecimal1?: null | number;
                      freeDecimal2?: null | number;
                      freeDecimal3?: null | number;
                  };
                  goodsOwner?: {
                      id?: number;
                      name?: null | string;
                  };
                  height?: null | number;
                  inventoryInfo?: {
                      allocatedNumberOfItems?: number;
                      lastInDate?: null | string;
                      lockedForSaleNumberOfItems?: number;
                      numberOfBookedItems?: number;
                      numberOfItems?: number;
                      numberOfLockedItems?: number;
                      pickedToBeCollectedNumberOfItems?: number;
                      receivedToBeFinishedNumberOfItems?: number;
                      sellableNumberOfItems?: number;
                      toReceiveNumberOfItems?: number;
                      totalStockValue?: number;
                  };
                  isActive?: null | boolean;
                  isStockArticle?: null | boolean;
                  length?: null | number;
                  linkToPicture?: null | string;
                  minimumReorderQuantity?: null | number;
                  netWeight?: null | number;
                  productCode?: null | string;
                  purcaseCurrencyCode?: null | string;
                  purchasePrice?: null | number;
                  quantityPerPackage?: null | number;
                  quantityPerPallet?: null | number;
                  statisticsNumber?: null | string;
                  stockLimit?: null | number;
                  stockValuationPrice?: null | number;
                  storageProperties?: {
                      isObsolete?: boolean;
                  };
                  subQuantityPerItem?: null | number;
                  supplierInfo?: {
                      alternativeSuppliers?: null | {
                          supplierArticleNumber?: null | string;
                          supplierName?: null | string;
                          supplierNumber?: null | string;
                      }[];
                      supplierArticleNumber?: null | string;
                      supplierName?: null | string;
                      supplierNumber?: null | string;
                  };
                  taricNumbersInfo?: {
                      taricNumbers?: null | {
                          countryCode?: null | string;
                          taricNumber?: null | string;
                      }[];
                  };
                  unitCode?: null | string;
                  volume?: null | number;
                  weight?: null | number;
                  width?: null | number;
              }[];
          };
      }
      • content: {
            application/json: null | {
                articleCategory?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleDataLastUpdated?: null | string;
                articleGroup?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleKind?: null | string;
                articleName?: null | string;
                articleNumber?: null | string;
                articleSystemId?: number;
                barCodeInfo?: {
                    alternativeBarCodes?: null | {
                        barCode?: null | string;
                        barCodeType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        quantityPerBarCode?: null | number;
                    }[];
                    barCode?: null | string;
                    barCodePackage?: null | string;
                    barCodePallet?: null | string;
                };
                classes?: null | {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                }[];
                countryOfOriginCode?: null | string;
                customerPrice?: null | number;
                customsDescription?: null | string;
                defaultLocation?: {
                    name?: null | string;
                };
                defaultLocationMaxNumberOfItems?: null | number;
                defaultLocationStockLimit?: null | number;
                description?: null | string;
                freeValues?: {
                    freeBoolean1?: boolean;
                    freeBoolean2?: boolean;
                    freeBoolean3?: boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeDecimal3?: null | number;
                };
                goodsOwner?: {
                    id?: number;
                    name?: null | string;
                };
                height?: null | number;
                inventoryInfo?: {
                    allocatedNumberOfItems?: number;
                    lastInDate?: null | string;
                    lockedForSaleNumberOfItems?: number;
                    numberOfBookedItems?: number;
                    numberOfItems?: number;
                    numberOfLockedItems?: number;
                    pickedToBeCollectedNumberOfItems?: number;
                    receivedToBeFinishedNumberOfItems?: number;
                    sellableNumberOfItems?: number;
                    toReceiveNumberOfItems?: number;
                    totalStockValue?: number;
                };
                isActive?: null | boolean;
                isStockArticle?: null | boolean;
                length?: null | number;
                linkToPicture?: null | string;
                minimumReorderQuantity?: null | number;
                netWeight?: null | number;
                productCode?: null | string;
                purcaseCurrencyCode?: null | string;
                purchasePrice?: null | number;
                quantityPerPackage?: null | number;
                quantityPerPallet?: null | number;
                statisticsNumber?: null | string;
                stockLimit?: null | number;
                stockValuationPrice?: null | number;
                storageProperties?: {
                    isObsolete?: boolean;
                };
                subQuantityPerItem?: null | number;
                supplierInfo?: {
                    alternativeSuppliers?: null | {
                        supplierArticleNumber?: null | string;
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    }[];
                    supplierArticleNumber?: null | string;
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                taricNumbersInfo?: {
                    taricNumbers?: null | {
                        countryCode?: null | string;
                        taricNumber?: null | string;
                    }[];
                };
                unitCode?: null | string;
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            }[];
        }
        • application/json: null | {
              articleCategory?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleDataLastUpdated?: null | string;
              articleGroup?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleKind?: null | string;
              articleName?: null | string;
              articleNumber?: null | string;
              articleSystemId?: number;
              barCodeInfo?: {
                  alternativeBarCodes?: null | {
                      barCode?: null | string;
                      barCodeType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      quantityPerBarCode?: null | number;
                  }[];
                  barCode?: null | string;
                  barCodePackage?: null | string;
                  barCodePallet?: null | string;
              };
              classes?: null | {
                  code?: null | string;
                  id?: number;
                  name?: null | string;
              }[];
              countryOfOriginCode?: null | string;
              customerPrice?: null | number;
              customsDescription?: null | string;
              defaultLocation?: {
                  name?: null | string;
              };
              defaultLocationMaxNumberOfItems?: null | number;
              defaultLocationStockLimit?: null | number;
              description?: null | string;
              freeValues?: {
                  freeBoolean1?: boolean;
                  freeBoolean2?: boolean;
                  freeBoolean3?: boolean;
                  freeDecimal1?: null | number;
                  freeDecimal2?: null | number;
                  freeDecimal3?: null | number;
              };
              goodsOwner?: {
                  id?: number;
                  name?: null | string;
              };
              height?: null | number;
              inventoryInfo?: {
                  allocatedNumberOfItems?: number;
                  lastInDate?: null | string;
                  lockedForSaleNumberOfItems?: number;
                  numberOfBookedItems?: number;
                  numberOfItems?: number;
                  numberOfLockedItems?: number;
                  pickedToBeCollectedNumberOfItems?: number;
                  receivedToBeFinishedNumberOfItems?: number;
                  sellableNumberOfItems?: number;
                  toReceiveNumberOfItems?: number;
                  totalStockValue?: number;
              };
              isActive?: null | boolean;
              isStockArticle?: null | boolean;
              length?: null | number;
              linkToPicture?: null | string;
              minimumReorderQuantity?: null | number;
              netWeight?: null | number;
              productCode?: null | string;
              purcaseCurrencyCode?: null | string;
              purchasePrice?: null | number;
              quantityPerPackage?: null | number;
              quantityPerPallet?: null | number;
              statisticsNumber?: null | string;
              stockLimit?: null | number;
              stockValuationPrice?: null | number;
              storageProperties?: {
                  isObsolete?: boolean;
              };
              subQuantityPerItem?: null | number;
              supplierInfo?: {
                  alternativeSuppliers?: null | {
                      supplierArticleNumber?: null | string;
                      supplierName?: null | string;
                      supplierNumber?: null | string;
                  }[];
                  supplierArticleNumber?: null | string;
                  supplierName?: null | string;
                  supplierNumber?: null | string;
              };
              taricNumbersInfo?: {
                  taricNumbers?: null | {
                      countryCode?: null | string;
                      taricNumber?: null | string;
                  }[];
              };
              unitCode?: null | string;
              volume?: null | number;
              weight?: null | number;
              width?: null | number;
          }[]
Articles_GetArticleClasses: {
    parameters: {
        query: {
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleClasses?: null | {
                        code?: null | string;
                        comment?: null | string;
                        id?: number;
                        name?: null | string;
                    }[];
                };
            };
        };
    };
}

Get all article classes.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
        };
    }
    • query: {
          goodsOwnerId: number;
      }
      • goodsOwnerId: number
  • responses: {
        200: {
            content: {
                application/json: {
                    articleClasses?: null | {
                        code?: null | string;
                        comment?: null | string;
                        id?: number;
                        name?: null | string;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleClasses?: null | {
                      code?: null | string;
                      comment?: null | string;
                      id?: number;
                      name?: null | string;
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                articleClasses?: null | {
                    code?: null | string;
                    comment?: null | string;
                    id?: number;
                    name?: null | string;
                }[];
            };
        }
        • application/json: {
              articleClasses?: null | {
                  code?: null | string;
                  comment?: null | string;
                  id?: number;
                  name?: null | string;
              }[];
          }
          • Optional articleClasses?: null | {
                code?: null | string;
                comment?: null | string;
                id?: number;
                name?: null | string;
            }[]
Articles_GetDangerousGoods: {
    parameters: {
        path: {
            articleSystemId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    dangerousGoods?: {
                        dangerousGoodsCoefficient?: null | number;
                        emsCode?: null | string;
                        unIsMarineHazard?: boolean;
                        unLabelNumbers?: null | string;
                        unNumber?: {
                            unClassNumber?: null | string;
                            unNumber?: null | string;
                            unTunnelCodes?: null | {
                                unTunnelCode?: null | string;
                            }[];
                        };
                        unPackageType?: null | string;
                        unProperShippingNames?: null | {
                            languageCode?: null | string;
                            name?: null | string;
                        }[];
                    };
                };
            };
        };
    };
}

Get dangerous goods info for an article.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
        };
    }
    • path: {
          articleSystemId: number;
      }
      • articleSystemId: number

        Description

        Article system ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    dangerousGoods?: {
                        dangerousGoodsCoefficient?: null | number;
                        emsCode?: null | string;
                        unIsMarineHazard?: boolean;
                        unLabelNumbers?: null | string;
                        unNumber?: {
                            unClassNumber?: null | string;
                            unNumber?: null | string;
                            unTunnelCodes?: null | {
                                unTunnelCode?: null | string;
                            }[];
                        };
                        unPackageType?: null | string;
                        unProperShippingNames?: null | {
                            languageCode?: null | string;
                            name?: null | string;
                        }[];
                    };
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  dangerousGoods?: {
                      dangerousGoodsCoefficient?: null | number;
                      emsCode?: null | string;
                      unIsMarineHazard?: boolean;
                      unLabelNumbers?: null | string;
                      unNumber?: {
                          unClassNumber?: null | string;
                          unNumber?: null | string;
                          unTunnelCodes?: null | {
                              unTunnelCode?: null | string;
                          }[];
                      };
                      unPackageType?: null | string;
                      unProperShippingNames?: null | {
                          languageCode?: null | string;
                          name?: null | string;
                      }[];
                  };
              };
          };
      }
      • content: {
            application/json: {
                articleNumber?: null | string;
                articleSystemId?: number;
                dangerousGoods?: {
                    dangerousGoodsCoefficient?: null | number;
                    emsCode?: null | string;
                    unIsMarineHazard?: boolean;
                    unLabelNumbers?: null | string;
                    unNumber?: {
                        unClassNumber?: null | string;
                        unNumber?: null | string;
                        unTunnelCodes?: null | {
                            unTunnelCode?: null | string;
                        }[];
                    };
                    unPackageType?: null | string;
                    unProperShippingNames?: null | {
                        languageCode?: null | string;
                        name?: null | string;
                    }[];
                };
            };
        }
        • application/json: {
              articleNumber?: null | string;
              articleSystemId?: number;
              dangerousGoods?: {
                  dangerousGoodsCoefficient?: null | number;
                  emsCode?: null | string;
                  unIsMarineHazard?: boolean;
                  unLabelNumbers?: null | string;
                  unNumber?: {
                      unClassNumber?: null | string;
                      unNumber?: null | string;
                      unTunnelCodes?: null | {
                          unTunnelCode?: null | string;
                      }[];
                  };
                  unPackageType?: null | string;
                  unProperShippingNames?: null | {
                      languageCode?: null | string;
                      name?: null | string;
                  }[];
              };
          }
          • Optional articleNumber?: null | string
          • Optional articleSystemId?: number

            Format: int32

          • Optional dangerousGoods?: {
                dangerousGoodsCoefficient?: null | number;
                emsCode?: null | string;
                unIsMarineHazard?: boolean;
                unLabelNumbers?: null | string;
                unNumber?: {
                    unClassNumber?: null | string;
                    unNumber?: null | string;
                    unTunnelCodes?: null | {
                        unTunnelCode?: null | string;
                    }[];
                };
                unPackageType?: null | string;
                unProperShippingNames?: null | {
                    languageCode?: null | string;
                    name?: null | string;
                }[];
            }
            • Optional dangerousGoodsCoefficient?: null | number

              Format: decimal

            • Optional emsCode?: null | string
            • Optional unIsMarineHazard?: boolean
            • Optional unLabelNumbers?: null | string
            • Optional unNumber?: {
                  unClassNumber?: null | string;
                  unNumber?: null | string;
                  unTunnelCodes?: null | {
                      unTunnelCode?: null | string;
                  }[];
              }
              • Optional unClassNumber?: null | string
              • Optional unNumber?: null | string
              • Optional unTunnelCodes?: null | {
                    unTunnelCode?: null | string;
                }[]
            • Optional unPackageType?: null | string
            • Optional unProperShippingNames?: null | {
                  languageCode?: null | string;
                  name?: null | string;
              }[]
Articles_GetDangerousGoodsByArticleNumber: {
    parameters: {
        query: {
            articleNumbers?: null | string[];
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    dangerousGoods?: {
                        dangerousGoodsCoefficient?: null | number;
                        emsCode?: null | string;
                        unIsMarineHazard?: boolean;
                        unLabelNumbers?: null | string;
                        unNumber?: {
                            unClassNumber?: null | string;
                            unNumber?: null | string;
                            unTunnelCodes?: null | {
                                unTunnelCode?: null | string;
                            }[];
                        };
                        unPackageType?: null | string;
                        unProperShippingNames?: null | {
                            languageCode?: null | string;
                            name?: null | string;
                        }[];
                    };
                }[];
            };
        };
    };
}

Get dangerous goods info for articles, using article numbers.

Type declaration

  • parameters: {
        query: {
            articleNumbers?: null | string[];
            goodsOwnerId: number;
        };
    }
    • query: {
          articleNumbers?: null | string[];
          goodsOwnerId: number;
      }
      • Optional articleNumbers?: null | string[]

        Description

        Article numbers to get dangerous goods information for.

      • goodsOwnerId: number

        Description

        Goods owner ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    dangerousGoods?: {
                        dangerousGoodsCoefficient?: null | number;
                        emsCode?: null | string;
                        unIsMarineHazard?: boolean;
                        unLabelNumbers?: null | string;
                        unNumber?: {
                            unClassNumber?: null | string;
                            unNumber?: null | string;
                            unTunnelCodes?: null | {
                                unTunnelCode?: null | string;
                            }[];
                        };
                        unPackageType?: null | string;
                        unProperShippingNames?: null | {
                            languageCode?: null | string;
                            name?: null | string;
                        }[];
                    };
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  dangerousGoods?: {
                      dangerousGoodsCoefficient?: null | number;
                      emsCode?: null | string;
                      unIsMarineHazard?: boolean;
                      unLabelNumbers?: null | string;
                      unNumber?: {
                          unClassNumber?: null | string;
                          unNumber?: null | string;
                          unTunnelCodes?: null | {
                              unTunnelCode?: null | string;
                          }[];
                      };
                      unPackageType?: null | string;
                      unProperShippingNames?: null | {
                          languageCode?: null | string;
                          name?: null | string;
                      }[];
                  };
              }[];
          };
      }
      • content: {
            application/json: {
                articleNumber?: null | string;
                articleSystemId?: number;
                dangerousGoods?: {
                    dangerousGoodsCoefficient?: null | number;
                    emsCode?: null | string;
                    unIsMarineHazard?: boolean;
                    unLabelNumbers?: null | string;
                    unNumber?: {
                        unClassNumber?: null | string;
                        unNumber?: null | string;
                        unTunnelCodes?: null | {
                            unTunnelCode?: null | string;
                        }[];
                    };
                    unPackageType?: null | string;
                    unProperShippingNames?: null | {
                        languageCode?: null | string;
                        name?: null | string;
                    }[];
                };
            }[];
        }
        • application/json: {
              articleNumber?: null | string;
              articleSystemId?: number;
              dangerousGoods?: {
                  dangerousGoodsCoefficient?: null | number;
                  emsCode?: null | string;
                  unIsMarineHazard?: boolean;
                  unLabelNumbers?: null | string;
                  unNumber?: {
                      unClassNumber?: null | string;
                      unNumber?: null | string;
                      unTunnelCodes?: null | {
                          unTunnelCode?: null | string;
                      }[];
                  };
                  unPackageType?: null | string;
                  unProperShippingNames?: null | {
                      languageCode?: null | string;
                      name?: null | string;
                  }[];
              };
          }[]
Articles_GetFiles: {
    parameters: {
        path: {
            articleSystemId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    articleSystemId?: null | number;
                    fileDataBase64?: null | string;
                    fileId?: number;
                    fileName?: null | string;
                    mimeType?: null | string;
                    orderId?: null | number;
                    purchaseOrderId?: null | number;
                }[];
            };
        };
    };
}

Get all files which are attached to a specific article.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
        };
    }
    • path: {
          articleSystemId: number;
      }
      • articleSystemId: number

        Description

        Article system ID.

  • responses: {
        200: {
            content: {
                application/json: null | {
                    articleSystemId?: null | number;
                    fileDataBase64?: null | string;
                    fileId?: number;
                    fileName?: null | string;
                    mimeType?: null | string;
                    orderId?: null | number;
                    purchaseOrderId?: null | number;
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  articleSystemId?: null | number;
                  fileDataBase64?: null | string;
                  fileId?: number;
                  fileName?: null | string;
                  mimeType?: null | string;
                  orderId?: null | number;
                  purchaseOrderId?: null | number;
              }[];
          };
      }
      • content: {
            application/json: null | {
                articleSystemId?: null | number;
                fileDataBase64?: null | string;
                fileId?: number;
                fileName?: null | string;
                mimeType?: null | string;
                orderId?: null | number;
                purchaseOrderId?: null | number;
            }[];
        }
        • application/json: null | {
              articleSystemId?: null | number;
              fileDataBase64?: null | string;
              fileId?: number;
              fileName?: null | string;
              mimeType?: null | string;
              orderId?: null | number;
              purchaseOrderId?: null | number;
          }[]
Articles_GetHistoricalInventory: {
    parameters: {
        query: {
            goodsOwnerId: number;
            stockDate: string;
            warehouseId?: null | number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articles?: null | {
                        articleItems?: null | {
                            batch?: null | string;
                            numberOfItems?: number;
                            serial?: null | string;
                        }[];
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        numberOfItems?: number;
                        productCode?: null | string;
                    }[];
                }[];
            };
        };
    };
}

Get the historical stock balances for all articles at a specific time in the past.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
            stockDate: string;
            warehouseId?: null | number;
        };
    }
    • query: {
          goodsOwnerId: number;
          stockDate: string;
          warehouseId?: null | number;
      }
      • goodsOwnerId: number

        Description

        Goods owner ID.

      • stockDate: string

        Description

        The date for which you want stock balance information.

      • Optional warehouseId?: null | number

        Description

        If specified, will only give you the stock balances for this particular warehouse.

  • responses: {
        200: {
            content: {
                application/json: {
                    articles?: null | {
                        articleItems?: null | {
                            batch?: null | string;
                            numberOfItems?: number;
                            serial?: null | string;
                        }[];
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        numberOfItems?: number;
                        productCode?: null | string;
                    }[];
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articles?: null | {
                      articleItems?: null | {
                          batch?: null | string;
                          numberOfItems?: number;
                          serial?: null | string;
                      }[];
                      articleName?: null | string;
                      articleNumber?: null | string;
                      articleSystemId?: number;
                      numberOfItems?: number;
                      productCode?: null | string;
                  }[];
              }[];
          };
      }
      • content: {
            application/json: {
                articles?: null | {
                    articleItems?: null | {
                        batch?: null | string;
                        numberOfItems?: number;
                        serial?: null | string;
                    }[];
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    numberOfItems?: number;
                    productCode?: null | string;
                }[];
            }[];
        }
        • application/json: {
              articles?: null | {
                  articleItems?: null | {
                      batch?: null | string;
                      numberOfItems?: number;
                      serial?: null | string;
                  }[];
                  articleName?: null | string;
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  numberOfItems?: number;
                  productCode?: null | string;
              }[];
          }[]
Articles_GetInventoryPerWarehouse: {
    parameters: {
        query: {
            articleNumbers?: null | string[];
            articleSystemIdFrom?: null | number;
            goodsOwnerId: number;
            maxArticlesToGet?: null | number;
            onlyArticlesInStock?: null | boolean;
            stockInfoChangedFrom?: null | string;
            warehouseIds?: null | number[];
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    inventoryPerWarehouse?: null | {
                        availableForSaleNumberOfItems?: number;
                        numberOfItems?: number;
                        numberOfLockedItems?: number;
                        reported?: {
                            pickedToBeReportedNumberOfItems?: number;
                            receivedToBeReportedNumberOfItems?: number;
                            returnedToBeReportedNumberOfItems?: number;
                        };
                        sellableNumberOfItems?: number;
                        warehouseId?: number;
                    }[];
                }[];
            };
        };
    };
}

Get inventory info (specified per warehouse) for the articles which match the filter.

Type declaration

  • parameters: {
        query: {
            articleNumbers?: null | string[];
            articleSystemIdFrom?: null | number;
            goodsOwnerId: number;
            maxArticlesToGet?: null | number;
            onlyArticlesInStock?: null | boolean;
            stockInfoChangedFrom?: null | string;
            warehouseIds?: null | number[];
        };
    }
    • query: {
          articleNumbers?: null | string[];
          articleSystemIdFrom?: null | number;
          goodsOwnerId: number;
          maxArticlesToGet?: null | number;
          onlyArticlesInStock?: null | boolean;
          stockInfoChangedFrom?: null | string;
          warehouseIds?: null | number[];
      }
      • Optional articleNumbers?: null | string[]

        Description

        Only return info for these article numbers.

      • Optional articleSystemIdFrom?: null | number

        Description

        Only return articles whose article system ID is greater than or equal to this.

      • goodsOwnerId: number

        Description

        Goods owner ID.

      • Optional maxArticlesToGet?: null | number

        Description

        Maximum number of articles to return.

      • Optional onlyArticlesInStock?: null | boolean

        Description

        Only return articles where which are in stock in at least one warehouse.

      • Optional stockInfoChangedFrom?: null | string

        Description

        Only return articles where the stock info has changed after this time. Note that it must be be within 24 hours of the current time.

      • Optional warehouseIds?: null | number[]

        Description

        Only return info for these warehouses.

  • responses: {
        200: {
            content: {
                application/json: {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    inventoryPerWarehouse?: null | {
                        availableForSaleNumberOfItems?: number;
                        numberOfItems?: number;
                        numberOfLockedItems?: number;
                        reported?: {
                            pickedToBeReportedNumberOfItems?: number;
                            receivedToBeReportedNumberOfItems?: number;
                            returnedToBeReportedNumberOfItems?: number;
                        };
                        sellableNumberOfItems?: number;
                        warehouseId?: number;
                    }[];
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  inventoryPerWarehouse?: null | {
                      availableForSaleNumberOfItems?: number;
                      numberOfItems?: number;
                      numberOfLockedItems?: number;
                      reported?: {
                          pickedToBeReportedNumberOfItems?: number;
                          receivedToBeReportedNumberOfItems?: number;
                          returnedToBeReportedNumberOfItems?: number;
                      };
                      sellableNumberOfItems?: number;
                      warehouseId?: number;
                  }[];
              }[];
          };
      }
      • content: {
            application/json: {
                articleNumber?: null | string;
                articleSystemId?: number;
                inventoryPerWarehouse?: null | {
                    availableForSaleNumberOfItems?: number;
                    numberOfItems?: number;
                    numberOfLockedItems?: number;
                    reported?: {
                        pickedToBeReportedNumberOfItems?: number;
                        receivedToBeReportedNumberOfItems?: number;
                        returnedToBeReportedNumberOfItems?: number;
                    };
                    sellableNumberOfItems?: number;
                    warehouseId?: number;
                }[];
            }[];
        }
        • application/json: {
              articleNumber?: null | string;
              articleSystemId?: number;
              inventoryPerWarehouse?: null | {
                  availableForSaleNumberOfItems?: number;
                  numberOfItems?: number;
                  numberOfLockedItems?: number;
                  reported?: {
                      pickedToBeReportedNumberOfItems?: number;
                      receivedToBeReportedNumberOfItems?: number;
                      returnedToBeReportedNumberOfItems?: number;
                  };
                  sellableNumberOfItems?: number;
                  warehouseId?: number;
              }[];
          }[]
Articles_GetStructureRows: {
    parameters: {
        path: {
            articleSystemId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleKind?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    rows?: null | {
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        numberOfItems?: null | number;
                    }[];
                };
            };
        };
    };
}

Get all structure rows for structure articles and production articles.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
        };
    }
    • path: {
          articleSystemId: number;
      }
      • articleSystemId: number

        Description

        Article system ID of the structure article or production article.

  • responses: {
        200: {
            content: {
                application/json: {
                    articleKind?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    rows?: null | {
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        numberOfItems?: null | number;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleKind?: null | string;
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  rows?: null | {
                      articleNumber?: null | string;
                      articleSystemId?: number;
                      numberOfItems?: null | number;
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                articleKind?: null | string;
                articleNumber?: null | string;
                articleSystemId?: number;
                rows?: null | {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    numberOfItems?: null | number;
                }[];
            };
        }
        • application/json: {
              articleKind?: null | string;
              articleNumber?: null | string;
              articleSystemId?: number;
              rows?: null | {
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  numberOfItems?: null | number;
              }[];
          }
          • Optional articleKind?: null | string
          • Optional articleNumber?: null | string
          • Optional articleSystemId?: number

            Format: int32

          • Optional rows?: null | {
                articleNumber?: null | string;
                articleSystemId?: number;
                numberOfItems?: null | number;
            }[]
Articles_GetStructureRowsByArticleNumber: {
    parameters: {
        query: {
            articleKind: null | string;
            articleNumbers?: null | string[];
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleKind?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    rows?: null | {
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        numberOfItems?: null | number;
                    }[];
                }[];
            };
        };
    };
}

Get all structure rows for structure articles and production articles, by using article numbers.

Type declaration

  • parameters: {
        query: {
            articleKind: null | string;
            articleNumbers?: null | string[];
            goodsOwnerId: number;
        };
    }
    • query: {
          articleKind: null | string;
          articleNumbers?: null | string[];
          goodsOwnerId: number;
      }
      • articleKind: null | string

        Description

        If you want to filter for strucutre articles, put 'Structure' here. If you want to filter for production articles, put 'Production' here.

      • Optional articleNumbers?: null | string[]

        Description

        Article numbers to get structure information for.

      • goodsOwnerId: number

        Description

        Goods owner ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    articleKind?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    rows?: null | {
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        numberOfItems?: null | number;
                    }[];
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleKind?: null | string;
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  rows?: null | {
                      articleNumber?: null | string;
                      articleSystemId?: number;
                      numberOfItems?: null | number;
                  }[];
              }[];
          };
      }
      • content: {
            application/json: {
                articleKind?: null | string;
                articleNumber?: null | string;
                articleSystemId?: number;
                rows?: null | {
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    numberOfItems?: null | number;
                }[];
            }[];
        }
        • application/json: {
              articleKind?: null | string;
              articleNumber?: null | string;
              articleSystemId?: number;
              rows?: null | {
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  numberOfItems?: null | number;
              }[];
          }[]
Articles_Post: {
    parameters: {
        path: {
            articleSystemId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Create a new file and attach it to the specified article.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
        };
    }
    • path: {
          articleSystemId: number;
      }
      • articleSystemId: number

        Description

        Article system ID.

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    }

    Description

    File object, containing all file data.

    • content: {
          application/json: {
              advanced?: {
                  printingInfo?: {
                      printAsUser?: {
                          userId?: null | number;
                      };
                      printAsWorkstation?: {
                          workstationId?: null | number;
                      };
                      reportId?: null | number;
                  };
              };
              fileDataBase64: string;
              fileName: string;
              mimeType: string;
          };
      }
      • application/json: {
            advanced?: {
                printingInfo?: {
                    printAsUser?: {
                        userId?: null | number;
                    };
                    printAsWorkstation?: {
                        workstationId?: null | number;
                    };
                    reportId?: null | number;
                };
            };
            fileDataBase64: string;
            fileName: string;
            mimeType: string;
        }
        • Optional advanced?: {
              printingInfo?: {
                  printAsUser?: {
                      userId?: null | number;
                  };
                  printAsWorkstation?: {
                      workstationId?: null | number;
                  };
                  reportId?: null | number;
              };
          }
          • Optional printingInfo?: {
                printAsUser?: {
                    userId?: null | number;
                };
                printAsWorkstation?: {
                    workstationId?: null | number;
                };
                reportId?: null | number;
            }
            • Optional printAsUser?: {
                  userId?: null | number;
              }
              • Optional userId?: null | number

                Format: int32

            • Optional printAsWorkstation?: {
                  workstationId?: null | number;
              }
              • Optional workstationId?: null | number

                Format: int32

            • Optional reportId?: null | number

              Format: int32

        • fileDataBase64: string
        • fileName: string
        • mimeType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
Articles_Put: {
    parameters: {
        path: {
            articleSystemId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                articleCategory?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleColor?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleGroup?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleName?: null | string;
                articleNameTranslations?: null | {
                    articleName?: null | string;
                    languageCode?: null | string;
                }[];
                articleNumber: string;
                articleSize?: {
                    code?: null | string;
                    name?: null | string;
                };
                barCodeInfo?: {
                    alternativeBarCodes?: null | {
                        barCode?: null | string;
                        barCodeType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        quantityPerBarCode?: null | number;
                    }[];
                    barCode?: null | string;
                    barCodePackage?: null | string;
                    barCodePallet?: null | string;
                };
                countryOfOriginCode?: null | string;
                customerPrice?: null | number;
                customsDescription?: null | string;
                description?: null | string;
                freeValues?: {
                    freeBoolean1?: null | boolean;
                    freeBoolean2?: null | boolean;
                    freeBoolean3?: null | boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeDecimal3?: null | number;
                };
                goodsOwnerId: number;
                height?: null | number;
                isActive?: null | boolean;
                isStockArticle?: null | boolean;
                length?: null | number;
                linkToPicture?: null | string;
                minDaysToExpiryDateAllowedOnDelivery?: null | number;
                minimumReorderQuantity?: null | number;
                netWeight?: null | number;
                productCode?: null | string;
                purcaseCurrencyCode?: null | string;
                purchasePrice?: null | number;
                quantityPerLayerOnPallet?: null | number;
                quantityPerPackage?: null | number;
                quantityPerPallet?: null | number;
                statisticsNumber?: null | string;
                stockLimit?: null | number;
                stockValuationPrice?: null | number;
                storageClass?: {
                    name: string;
                };
                storageProperties?: {
                    isBatchArticle?: null | boolean;
                    isExpiryDateArticle?: null | boolean;
                    isObsolete?: null | boolean;
                    isSerialNumberArticle?: null | boolean;
                };
                structureDefinition?: {
                    articleKind?: "Structure" | "Production";
                    rows?: null | {
                        articleNumber: string;
                        numberOfItems?: number;
                    }[];
                };
                subQuantityPerItem?: null | number;
                supplierInfo?: {
                    supplierArticleNumber?: null | string;
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                taricNumbersInfo?: {
                    taricNumbers?: null | {
                        countryCode: string;
                        taricNumber: string;
                    }[];
                };
                unitCode?: null | string;
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleSystemId?: null | number;
                    message?: null | string;
                };
            };
        };
    };
}

Update an existing article. Note that the articleSystemId refers to Ongoing WMS' internal ID for the article.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
        };
    }
    • path: {
          articleSystemId: number;
      }
      • articleSystemId: number

        Description

        Article system ID for the article which the file is attached to.

  • requestBody: {
        content: {
            application/json: {
                articleCategory?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleColor?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleGroup?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleName?: null | string;
                articleNameTranslations?: null | {
                    articleName?: null | string;
                    languageCode?: null | string;
                }[];
                articleNumber: string;
                articleSize?: {
                    code?: null | string;
                    name?: null | string;
                };
                barCodeInfo?: {
                    alternativeBarCodes?: null | {
                        barCode?: null | string;
                        barCodeType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        quantityPerBarCode?: null | number;
                    }[];
                    barCode?: null | string;
                    barCodePackage?: null | string;
                    barCodePallet?: null | string;
                };
                countryOfOriginCode?: null | string;
                customerPrice?: null | number;
                customsDescription?: null | string;
                description?: null | string;
                freeValues?: {
                    freeBoolean1?: null | boolean;
                    freeBoolean2?: null | boolean;
                    freeBoolean3?: null | boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeDecimal3?: null | number;
                };
                goodsOwnerId: number;
                height?: null | number;
                isActive?: null | boolean;
                isStockArticle?: null | boolean;
                length?: null | number;
                linkToPicture?: null | string;
                minDaysToExpiryDateAllowedOnDelivery?: null | number;
                minimumReorderQuantity?: null | number;
                netWeight?: null | number;
                productCode?: null | string;
                purcaseCurrencyCode?: null | string;
                purchasePrice?: null | number;
                quantityPerLayerOnPallet?: null | number;
                quantityPerPackage?: null | number;
                quantityPerPallet?: null | number;
                statisticsNumber?: null | string;
                stockLimit?: null | number;
                stockValuationPrice?: null | number;
                storageClass?: {
                    name: string;
                };
                storageProperties?: {
                    isBatchArticle?: null | boolean;
                    isExpiryDateArticle?: null | boolean;
                    isObsolete?: null | boolean;
                    isSerialNumberArticle?: null | boolean;
                };
                structureDefinition?: {
                    articleKind?: "Structure" | "Production";
                    rows?: null | {
                        articleNumber: string;
                        numberOfItems?: number;
                    }[];
                };
                subQuantityPerItem?: null | number;
                supplierInfo?: {
                    supplierArticleNumber?: null | string;
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                taricNumbersInfo?: {
                    taricNumbers?: null | {
                        countryCode: string;
                        taricNumber: string;
                    }[];
                };
                unitCode?: null | string;
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            };
        };
    }

    Description

    Article object, containing all article data.

    • content: {
          application/json: {
              articleCategory?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleColor?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleGroup?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleName?: null | string;
              articleNameTranslations?: null | {
                  articleName?: null | string;
                  languageCode?: null | string;
              }[];
              articleNumber: string;
              articleSize?: {
                  code?: null | string;
                  name?: null | string;
              };
              barCodeInfo?: {
                  alternativeBarCodes?: null | {
                      barCode?: null | string;
                      barCodeType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      quantityPerBarCode?: null | number;
                  }[];
                  barCode?: null | string;
                  barCodePackage?: null | string;
                  barCodePallet?: null | string;
              };
              countryOfOriginCode?: null | string;
              customerPrice?: null | number;
              customsDescription?: null | string;
              description?: null | string;
              freeValues?: {
                  freeBoolean1?: null | boolean;
                  freeBoolean2?: null | boolean;
                  freeBoolean3?: null | boolean;
                  freeDecimal1?: null | number;
                  freeDecimal2?: null | number;
                  freeDecimal3?: null | number;
              };
              goodsOwnerId: number;
              height?: null | number;
              isActive?: null | boolean;
              isStockArticle?: null | boolean;
              length?: null | number;
              linkToPicture?: null | string;
              minDaysToExpiryDateAllowedOnDelivery?: null | number;
              minimumReorderQuantity?: null | number;
              netWeight?: null | number;
              productCode?: null | string;
              purcaseCurrencyCode?: null | string;
              purchasePrice?: null | number;
              quantityPerLayerOnPallet?: null | number;
              quantityPerPackage?: null | number;
              quantityPerPallet?: null | number;
              statisticsNumber?: null | string;
              stockLimit?: null | number;
              stockValuationPrice?: null | number;
              storageClass?: {
                  name: string;
              };
              storageProperties?: {
                  isBatchArticle?: null | boolean;
                  isExpiryDateArticle?: null | boolean;
                  isObsolete?: null | boolean;
                  isSerialNumberArticle?: null | boolean;
              };
              structureDefinition?: {
                  articleKind?: "Structure" | "Production";
                  rows?: null | {
                      articleNumber: string;
                      numberOfItems?: number;
                  }[];
              };
              subQuantityPerItem?: null | number;
              supplierInfo?: {
                  supplierArticleNumber?: null | string;
                  supplierName?: null | string;
                  supplierNumber?: null | string;
              };
              taricNumbersInfo?: {
                  taricNumbers?: null | {
                      countryCode: string;
                      taricNumber: string;
                  }[];
              };
              unitCode?: null | string;
              volume?: null | number;
              weight?: null | number;
              width?: null | number;
          };
      }
      • application/json: {
            articleCategory?: {
                code?: null | string;
                name?: null | string;
            };
            articleColor?: {
                code?: null | string;
                name?: null | string;
            };
            articleGroup?: {
                code?: null | string;
                name?: null | string;
            };
            articleName?: null | string;
            articleNameTranslations?: null | {
                articleName?: null | string;
                languageCode?: null | string;
            }[];
            articleNumber: string;
            articleSize?: {
                code?: null | string;
                name?: null | string;
            };
            barCodeInfo?: {
                alternativeBarCodes?: null | {
                    barCode?: null | string;
                    barCodeType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    quantityPerBarCode?: null | number;
                }[];
                barCode?: null | string;
                barCodePackage?: null | string;
                barCodePallet?: null | string;
            };
            countryOfOriginCode?: null | string;
            customerPrice?: null | number;
            customsDescription?: null | string;
            description?: null | string;
            freeValues?: {
                freeBoolean1?: null | boolean;
                freeBoolean2?: null | boolean;
                freeBoolean3?: null | boolean;
                freeDecimal1?: null | number;
                freeDecimal2?: null | number;
                freeDecimal3?: null | number;
            };
            goodsOwnerId: number;
            height?: null | number;
            isActive?: null | boolean;
            isStockArticle?: null | boolean;
            length?: null | number;
            linkToPicture?: null | string;
            minDaysToExpiryDateAllowedOnDelivery?: null | number;
            minimumReorderQuantity?: null | number;
            netWeight?: null | number;
            productCode?: null | string;
            purcaseCurrencyCode?: null | string;
            purchasePrice?: null | number;
            quantityPerLayerOnPallet?: null | number;
            quantityPerPackage?: null | number;
            quantityPerPallet?: null | number;
            statisticsNumber?: null | string;
            stockLimit?: null | number;
            stockValuationPrice?: null | number;
            storageClass?: {
                name: string;
            };
            storageProperties?: {
                isBatchArticle?: null | boolean;
                isExpiryDateArticle?: null | boolean;
                isObsolete?: null | boolean;
                isSerialNumberArticle?: null | boolean;
            };
            structureDefinition?: {
                articleKind?: "Structure" | "Production";
                rows?: null | {
                    articleNumber: string;
                    numberOfItems?: number;
                }[];
            };
            subQuantityPerItem?: null | number;
            supplierInfo?: {
                supplierArticleNumber?: null | string;
                supplierName?: null | string;
                supplierNumber?: null | string;
            };
            taricNumbersInfo?: {
                taricNumbers?: null | {
                    countryCode: string;
                    taricNumber: string;
                }[];
            };
            unitCode?: null | string;
            volume?: null | number;
            weight?: null | number;
            width?: null | number;
        }
        • Optional articleCategory?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional articleColor?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional articleGroup?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional articleName?: null | string
        • Optional articleNameTranslations?: null | {
              articleName?: null | string;
              languageCode?: null | string;
          }[]
        • articleNumber: string
        • Optional articleSize?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional barCodeInfo?: {
              alternativeBarCodes?: null | {
                  barCode?: null | string;
                  barCodeType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  quantityPerBarCode?: null | number;
              }[];
              barCode?: null | string;
              barCodePackage?: null | string;
              barCodePallet?: null | string;
          }
          • Optional alternativeBarCodes?: null | {
                barCode?: null | string;
                barCodeType?: {
                    code?: null | string;
                    name?: null | string;
                };
                quantityPerBarCode?: null | number;
            }[]
          • Optional barCode?: null | string
          • Optional barCodePackage?: null | string
          • Optional barCodePallet?: null | string
        • Optional countryOfOriginCode?: null | string
        • Optional customerPrice?: null | number

          Format: decimal

        • Optional customsDescription?: null | string
        • Optional description?: null | string
        • Optional freeValues?: {
              freeBoolean1?: null | boolean;
              freeBoolean2?: null | boolean;
              freeBoolean3?: null | boolean;
              freeDecimal1?: null | number;
              freeDecimal2?: null | number;
              freeDecimal3?: null | number;
          }
          • Optional freeBoolean1?: null | boolean
          • Optional freeBoolean2?: null | boolean
          • Optional freeBoolean3?: null | boolean
          • Optional freeDecimal1?: null | number

            Format: decimal

          • Optional freeDecimal2?: null | number

            Format: decimal

          • Optional freeDecimal3?: null | number

            Format: decimal

        • goodsOwnerId: number

          Format: int32

        • Optional height?: null | number

          Format: decimal

        • Optional isActive?: null | boolean
        • Optional isStockArticle?: null | boolean
        • Optional length?: null | number

          Format: decimal

        • Optional linkToPicture?: null | string
        • Optional minDaysToExpiryDateAllowedOnDelivery?: null | number

          Format: int32

        • Optional minimumReorderQuantity?: null | number

          Format: decimal

        • Optional netWeight?: null | number

          Format: decimal

        • Optional productCode?: null | string
        • Optional purcaseCurrencyCode?: null | string
        • Optional purchasePrice?: null | number

          Format: decimal

        • Optional quantityPerLayerOnPallet?: null | number

          Format: int32

        • Optional quantityPerPackage?: null | number

          Format: int32

        • Optional quantityPerPallet?: null | number

          Format: int32

        • Optional statisticsNumber?: null | string
        • Optional stockLimit?: null | number

          Format: int32

        • Optional stockValuationPrice?: null | number

          Format: decimal

        • Optional storageClass?: {
              name: string;
          }
          • name: string
        • Optional storageProperties?: {
              isBatchArticle?: null | boolean;
              isExpiryDateArticle?: null | boolean;
              isObsolete?: null | boolean;
              isSerialNumberArticle?: null | boolean;
          }
          • Optional isBatchArticle?: null | boolean
          • Optional isExpiryDateArticle?: null | boolean
          • Optional isObsolete?: null | boolean
          • Optional isSerialNumberArticle?: null | boolean
        • Optional structureDefinition?: {
              articleKind?: "Structure" | "Production";
              rows?: null | {
                  articleNumber: string;
                  numberOfItems?: number;
              }[];
          }
          • Optional articleKind?: "Structure" | "Production"
          • Optional rows?: null | {
                articleNumber: string;
                numberOfItems?: number;
            }[]
        • Optional subQuantityPerItem?: null | number

          Format: decimal

        • Optional supplierInfo?: {
              supplierArticleNumber?: null | string;
              supplierName?: null | string;
              supplierNumber?: null | string;
          }
          • Optional supplierArticleNumber?: null | string
          • Optional supplierName?: null | string
          • Optional supplierNumber?: null | string
        • Optional taricNumbersInfo?: {
              taricNumbers?: null | {
                  countryCode: string;
                  taricNumber: string;
              }[];
          }
          • Optional taricNumbers?: null | {
                countryCode: string;
                taricNumber: string;
            }[]
        • Optional unitCode?: null | string
        • Optional volume?: null | number

          Format: decimal

        • Optional weight?: null | number

          Format: decimal

        • Optional width?: null | number

          Format: decimal

  • responses: {
        200: {
            content: {
                application/json: {
                    articleSystemId?: null | number;
                    message?: null | string;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleSystemId?: null | number;
                  message?: null | string;
              };
          };
      }
      • content: {
            application/json: {
                articleSystemId?: null | number;
                message?: null | string;
            };
        }
        • application/json: {
              articleSystemId?: null | number;
              message?: null | string;
          }
          • Optional articleSystemId?: null | number

            Format: int32

          • Optional message?: null | string
Articles_Put2: {
    parameters: {
        path: {
            articleSystemId: number;
            fileId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Update a file which is attached to an article.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
            fileId: number;
        };
    }
    • path: {
          articleSystemId: number;
          fileId: number;
      }
      • articleSystemId: number

        Description

        Article system ID for the article which the file is attached to.

      • fileId: number

        Description

        File ID, identifying the file which is to be updated.

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    }

    Description

    File object, containing all file data.

    • content: {
          application/json: {
              advanced?: {
                  printingInfo?: {
                      printAsUser?: {
                          userId?: null | number;
                      };
                      printAsWorkstation?: {
                          workstationId?: null | number;
                      };
                      reportId?: null | number;
                  };
              };
              fileDataBase64: string;
              fileName: string;
              mimeType: string;
          };
      }
      • application/json: {
            advanced?: {
                printingInfo?: {
                    printAsUser?: {
                        userId?: null | number;
                    };
                    printAsWorkstation?: {
                        workstationId?: null | number;
                    };
                    reportId?: null | number;
                };
            };
            fileDataBase64: string;
            fileName: string;
            mimeType: string;
        }
        • Optional advanced?: {
              printingInfo?: {
                  printAsUser?: {
                      userId?: null | number;
                  };
                  printAsWorkstation?: {
                      workstationId?: null | number;
                  };
                  reportId?: null | number;
              };
          }
          • Optional printingInfo?: {
                printAsUser?: {
                    userId?: null | number;
                };
                printAsWorkstation?: {
                    workstationId?: null | number;
                };
                reportId?: null | number;
            }
            • Optional printAsUser?: {
                  userId?: null | number;
              }
              • Optional userId?: null | number

                Format: int32

            • Optional printAsWorkstation?: {
                  workstationId?: null | number;
              }
              • Optional workstationId?: null | number

                Format: int32

            • Optional reportId?: null | number

              Format: int32

        • fileDataBase64: string
        • fileName: string
        • mimeType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
Articles_Put3: {
    requestBody: {
        content: {
            application/json: {
                articleCategory?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleColor?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleGroup?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleName?: null | string;
                articleNameTranslations?: null | {
                    articleName?: null | string;
                    languageCode?: null | string;
                }[];
                articleNumber: string;
                articleSize?: {
                    code?: null | string;
                    name?: null | string;
                };
                barCodeInfo?: {
                    alternativeBarCodes?: null | {
                        barCode?: null | string;
                        barCodeType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        quantityPerBarCode?: null | number;
                    }[];
                    barCode?: null | string;
                    barCodePackage?: null | string;
                    barCodePallet?: null | string;
                };
                countryOfOriginCode?: null | string;
                customerPrice?: null | number;
                customsDescription?: null | string;
                description?: null | string;
                freeValues?: {
                    freeBoolean1?: null | boolean;
                    freeBoolean2?: null | boolean;
                    freeBoolean3?: null | boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeDecimal3?: null | number;
                };
                goodsOwnerId: number;
                height?: null | number;
                isActive?: null | boolean;
                isStockArticle?: null | boolean;
                length?: null | number;
                linkToPicture?: null | string;
                minDaysToExpiryDateAllowedOnDelivery?: null | number;
                minimumReorderQuantity?: null | number;
                netWeight?: null | number;
                productCode?: null | string;
                purcaseCurrencyCode?: null | string;
                purchasePrice?: null | number;
                quantityPerLayerOnPallet?: null | number;
                quantityPerPackage?: null | number;
                quantityPerPallet?: null | number;
                statisticsNumber?: null | string;
                stockLimit?: null | number;
                stockValuationPrice?: null | number;
                storageClass?: {
                    name: string;
                };
                storageProperties?: {
                    isBatchArticle?: null | boolean;
                    isExpiryDateArticle?: null | boolean;
                    isObsolete?: null | boolean;
                    isSerialNumberArticle?: null | boolean;
                };
                structureDefinition?: {
                    articleKind?: "Structure" | "Production";
                    rows?: null | {
                        articleNumber: string;
                        numberOfItems?: number;
                    }[];
                };
                subQuantityPerItem?: null | number;
                supplierInfo?: {
                    supplierArticleNumber?: null | string;
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                taricNumbersInfo?: {
                    taricNumbers?: null | {
                        countryCode: string;
                        taricNumber: string;
                    }[];
                };
                unitCode?: null | string;
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleSystemId?: null | number;
                    message?: null | string;
                };
            };
        };
    };
}

Create or update an article. If no article with the specified article number exists, it will be created. Otherwise, it will be updated.

Type declaration

  • requestBody: {
        content: {
            application/json: {
                articleCategory?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleColor?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleGroup?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleName?: null | string;
                articleNameTranslations?: null | {
                    articleName?: null | string;
                    languageCode?: null | string;
                }[];
                articleNumber: string;
                articleSize?: {
                    code?: null | string;
                    name?: null | string;
                };
                barCodeInfo?: {
                    alternativeBarCodes?: null | {
                        barCode?: null | string;
                        barCodeType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        quantityPerBarCode?: null | number;
                    }[];
                    barCode?: null | string;
                    barCodePackage?: null | string;
                    barCodePallet?: null | string;
                };
                countryOfOriginCode?: null | string;
                customerPrice?: null | number;
                customsDescription?: null | string;
                description?: null | string;
                freeValues?: {
                    freeBoolean1?: null | boolean;
                    freeBoolean2?: null | boolean;
                    freeBoolean3?: null | boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeDecimal3?: null | number;
                };
                goodsOwnerId: number;
                height?: null | number;
                isActive?: null | boolean;
                isStockArticle?: null | boolean;
                length?: null | number;
                linkToPicture?: null | string;
                minDaysToExpiryDateAllowedOnDelivery?: null | number;
                minimumReorderQuantity?: null | number;
                netWeight?: null | number;
                productCode?: null | string;
                purcaseCurrencyCode?: null | string;
                purchasePrice?: null | number;
                quantityPerLayerOnPallet?: null | number;
                quantityPerPackage?: null | number;
                quantityPerPallet?: null | number;
                statisticsNumber?: null | string;
                stockLimit?: null | number;
                stockValuationPrice?: null | number;
                storageClass?: {
                    name: string;
                };
                storageProperties?: {
                    isBatchArticle?: null | boolean;
                    isExpiryDateArticle?: null | boolean;
                    isObsolete?: null | boolean;
                    isSerialNumberArticle?: null | boolean;
                };
                structureDefinition?: {
                    articleKind?: "Structure" | "Production";
                    rows?: null | {
                        articleNumber: string;
                        numberOfItems?: number;
                    }[];
                };
                subQuantityPerItem?: null | number;
                supplierInfo?: {
                    supplierArticleNumber?: null | string;
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                taricNumbersInfo?: {
                    taricNumbers?: null | {
                        countryCode: string;
                        taricNumber: string;
                    }[];
                };
                unitCode?: null | string;
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            };
        };
    }

    Description

    Article object, containing all article data.

    • content: {
          application/json: {
              articleCategory?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleColor?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleGroup?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleName?: null | string;
              articleNameTranslations?: null | {
                  articleName?: null | string;
                  languageCode?: null | string;
              }[];
              articleNumber: string;
              articleSize?: {
                  code?: null | string;
                  name?: null | string;
              };
              barCodeInfo?: {
                  alternativeBarCodes?: null | {
                      barCode?: null | string;
                      barCodeType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      quantityPerBarCode?: null | number;
                  }[];
                  barCode?: null | string;
                  barCodePackage?: null | string;
                  barCodePallet?: null | string;
              };
              countryOfOriginCode?: null | string;
              customerPrice?: null | number;
              customsDescription?: null | string;
              description?: null | string;
              freeValues?: {
                  freeBoolean1?: null | boolean;
                  freeBoolean2?: null | boolean;
                  freeBoolean3?: null | boolean;
                  freeDecimal1?: null | number;
                  freeDecimal2?: null | number;
                  freeDecimal3?: null | number;
              };
              goodsOwnerId: number;
              height?: null | number;
              isActive?: null | boolean;
              isStockArticle?: null | boolean;
              length?: null | number;
              linkToPicture?: null | string;
              minDaysToExpiryDateAllowedOnDelivery?: null | number;
              minimumReorderQuantity?: null | number;
              netWeight?: null | number;
              productCode?: null | string;
              purcaseCurrencyCode?: null | string;
              purchasePrice?: null | number;
              quantityPerLayerOnPallet?: null | number;
              quantityPerPackage?: null | number;
              quantityPerPallet?: null | number;
              statisticsNumber?: null | string;
              stockLimit?: null | number;
              stockValuationPrice?: null | number;
              storageClass?: {
                  name: string;
              };
              storageProperties?: {
                  isBatchArticle?: null | boolean;
                  isExpiryDateArticle?: null | boolean;
                  isObsolete?: null | boolean;
                  isSerialNumberArticle?: null | boolean;
              };
              structureDefinition?: {
                  articleKind?: "Structure" | "Production";
                  rows?: null | {
                      articleNumber: string;
                      numberOfItems?: number;
                  }[];
              };
              subQuantityPerItem?: null | number;
              supplierInfo?: {
                  supplierArticleNumber?: null | string;
                  supplierName?: null | string;
                  supplierNumber?: null | string;
              };
              taricNumbersInfo?: {
                  taricNumbers?: null | {
                      countryCode: string;
                      taricNumber: string;
                  }[];
              };
              unitCode?: null | string;
              volume?: null | number;
              weight?: null | number;
              width?: null | number;
          };
      }
      • application/json: {
            articleCategory?: {
                code?: null | string;
                name?: null | string;
            };
            articleColor?: {
                code?: null | string;
                name?: null | string;
            };
            articleGroup?: {
                code?: null | string;
                name?: null | string;
            };
            articleName?: null | string;
            articleNameTranslations?: null | {
                articleName?: null | string;
                languageCode?: null | string;
            }[];
            articleNumber: string;
            articleSize?: {
                code?: null | string;
                name?: null | string;
            };
            barCodeInfo?: {
                alternativeBarCodes?: null | {
                    barCode?: null | string;
                    barCodeType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    quantityPerBarCode?: null | number;
                }[];
                barCode?: null | string;
                barCodePackage?: null | string;
                barCodePallet?: null | string;
            };
            countryOfOriginCode?: null | string;
            customerPrice?: null | number;
            customsDescription?: null | string;
            description?: null | string;
            freeValues?: {
                freeBoolean1?: null | boolean;
                freeBoolean2?: null | boolean;
                freeBoolean3?: null | boolean;
                freeDecimal1?: null | number;
                freeDecimal2?: null | number;
                freeDecimal3?: null | number;
            };
            goodsOwnerId: number;
            height?: null | number;
            isActive?: null | boolean;
            isStockArticle?: null | boolean;
            length?: null | number;
            linkToPicture?: null | string;
            minDaysToExpiryDateAllowedOnDelivery?: null | number;
            minimumReorderQuantity?: null | number;
            netWeight?: null | number;
            productCode?: null | string;
            purcaseCurrencyCode?: null | string;
            purchasePrice?: null | number;
            quantityPerLayerOnPallet?: null | number;
            quantityPerPackage?: null | number;
            quantityPerPallet?: null | number;
            statisticsNumber?: null | string;
            stockLimit?: null | number;
            stockValuationPrice?: null | number;
            storageClass?: {
                name: string;
            };
            storageProperties?: {
                isBatchArticle?: null | boolean;
                isExpiryDateArticle?: null | boolean;
                isObsolete?: null | boolean;
                isSerialNumberArticle?: null | boolean;
            };
            structureDefinition?: {
                articleKind?: "Structure" | "Production";
                rows?: null | {
                    articleNumber: string;
                    numberOfItems?: number;
                }[];
            };
            subQuantityPerItem?: null | number;
            supplierInfo?: {
                supplierArticleNumber?: null | string;
                supplierName?: null | string;
                supplierNumber?: null | string;
            };
            taricNumbersInfo?: {
                taricNumbers?: null | {
                    countryCode: string;
                    taricNumber: string;
                }[];
            };
            unitCode?: null | string;
            volume?: null | number;
            weight?: null | number;
            width?: null | number;
        }
        • Optional articleCategory?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional articleColor?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional articleGroup?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional articleName?: null | string
        • Optional articleNameTranslations?: null | {
              articleName?: null | string;
              languageCode?: null | string;
          }[]
        • articleNumber: string
        • Optional articleSize?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional barCodeInfo?: {
              alternativeBarCodes?: null | {
                  barCode?: null | string;
                  barCodeType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  quantityPerBarCode?: null | number;
              }[];
              barCode?: null | string;
              barCodePackage?: null | string;
              barCodePallet?: null | string;
          }
          • Optional alternativeBarCodes?: null | {
                barCode?: null | string;
                barCodeType?: {
                    code?: null | string;
                    name?: null | string;
                };
                quantityPerBarCode?: null | number;
            }[]
          • Optional barCode?: null | string
          • Optional barCodePackage?: null | string
          • Optional barCodePallet?: null | string
        • Optional countryOfOriginCode?: null | string
        • Optional customerPrice?: null | number

          Format: decimal

        • Optional customsDescription?: null | string
        • Optional description?: null | string
        • Optional freeValues?: {
              freeBoolean1?: null | boolean;
              freeBoolean2?: null | boolean;
              freeBoolean3?: null | boolean;
              freeDecimal1?: null | number;
              freeDecimal2?: null | number;
              freeDecimal3?: null | number;
          }
          • Optional freeBoolean1?: null | boolean
          • Optional freeBoolean2?: null | boolean
          • Optional freeBoolean3?: null | boolean
          • Optional freeDecimal1?: null | number

            Format: decimal

          • Optional freeDecimal2?: null | number

            Format: decimal

          • Optional freeDecimal3?: null | number

            Format: decimal

        • goodsOwnerId: number

          Format: int32

        • Optional height?: null | number

          Format: decimal

        • Optional isActive?: null | boolean
        • Optional isStockArticle?: null | boolean
        • Optional length?: null | number

          Format: decimal

        • Optional linkToPicture?: null | string
        • Optional minDaysToExpiryDateAllowedOnDelivery?: null | number

          Format: int32

        • Optional minimumReorderQuantity?: null | number

          Format: decimal

        • Optional netWeight?: null | number

          Format: decimal

        • Optional productCode?: null | string
        • Optional purcaseCurrencyCode?: null | string
        • Optional purchasePrice?: null | number

          Format: decimal

        • Optional quantityPerLayerOnPallet?: null | number

          Format: int32

        • Optional quantityPerPackage?: null | number

          Format: int32

        • Optional quantityPerPallet?: null | number

          Format: int32

        • Optional statisticsNumber?: null | string
        • Optional stockLimit?: null | number

          Format: int32

        • Optional stockValuationPrice?: null | number

          Format: decimal

        • Optional storageClass?: {
              name: string;
          }
          • name: string
        • Optional storageProperties?: {
              isBatchArticle?: null | boolean;
              isExpiryDateArticle?: null | boolean;
              isObsolete?: null | boolean;
              isSerialNumberArticle?: null | boolean;
          }
          • Optional isBatchArticle?: null | boolean
          • Optional isExpiryDateArticle?: null | boolean
          • Optional isObsolete?: null | boolean
          • Optional isSerialNumberArticle?: null | boolean
        • Optional structureDefinition?: {
              articleKind?: "Structure" | "Production";
              rows?: null | {
                  articleNumber: string;
                  numberOfItems?: number;
              }[];
          }
          • Optional articleKind?: "Structure" | "Production"
          • Optional rows?: null | {
                articleNumber: string;
                numberOfItems?: number;
            }[]
        • Optional subQuantityPerItem?: null | number

          Format: decimal

        • Optional supplierInfo?: {
              supplierArticleNumber?: null | string;
              supplierName?: null | string;
              supplierNumber?: null | string;
          }
          • Optional supplierArticleNumber?: null | string
          • Optional supplierName?: null | string
          • Optional supplierNumber?: null | string
        • Optional taricNumbersInfo?: {
              taricNumbers?: null | {
                  countryCode: string;
                  taricNumber: string;
              }[];
          }
          • Optional taricNumbers?: null | {
                countryCode: string;
                taricNumber: string;
            }[]
        • Optional unitCode?: null | string
        • Optional volume?: null | number

          Format: decimal

        • Optional weight?: null | number

          Format: decimal

        • Optional width?: null | number

          Format: decimal

  • responses: {
        200: {
            content: {
                application/json: {
                    articleSystemId?: null | number;
                    message?: null | string;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleSystemId?: null | number;
                  message?: null | string;
              };
          };
      }
      • content: {
            application/json: {
                articleSystemId?: null | number;
                message?: null | string;
            };
        }
        • application/json: {
              articleSystemId?: null | number;
              message?: null | string;
          }
          • Optional articleSystemId?: null | number

            Format: int32

          • Optional message?: null | string
Articles_PutArticleClass: {
    requestBody: {
        content: {
            application/json: {
                code: string;
                comment?: null | string;
                goodsOwnerId: number;
                name: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleClassId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Create or update an article class. If there is no article class with the specified code, it will be created. Otherwise, the existing article class will be updated.

Type declaration

  • requestBody: {
        content: {
            application/json: {
                code: string;
                comment?: null | string;
                goodsOwnerId: number;
                name: string;
            };
        };
    }

    Description

    An object containing the article class type data.

    • content: {
          application/json: {
              code: string;
              comment?: null | string;
              goodsOwnerId: number;
              name: string;
          };
      }
      • application/json: {
            code: string;
            comment?: null | string;
            goodsOwnerId: number;
            name: string;
        }
        • code: string
        • Optional comment?: null | string
        • goodsOwnerId: number

          Format: int32

        • name: string
  • responses: {
        200: {
            content: {
                application/json: {
                    articleClassId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleClassId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                articleClassId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              articleClassId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional articleClassId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
Articles_PutArticleClassUsingId: {
    parameters: {
        path: {
            articleClassId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                code: string;
                comment?: null | string;
                goodsOwnerId: number;
                name: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleClassId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Update an article class. The ID will be used to identify the article class.

Type declaration

  • parameters: {
        path: {
            articleClassId: number;
        };
    }
    • path: {
          articleClassId: number;
      }
      • articleClassId: number

        Description

        Article class ID.

  • requestBody: {
        content: {
            application/json: {
                code: string;
                comment?: null | string;
                goodsOwnerId: number;
                name: string;
            };
        };
    }

    Description

    An object containing the article class data.

    • content: {
          application/json: {
              code: string;
              comment?: null | string;
              goodsOwnerId: number;
              name: string;
          };
      }
      • application/json: {
            code: string;
            comment?: null | string;
            goodsOwnerId: number;
            name: string;
        }
        • code: string
        • Optional comment?: null | string
        • goodsOwnerId: number

          Format: int32

        • name: string
  • responses: {
        200: {
            content: {
                application/json: {
                    articleClassId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleClassId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                articleClassId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              articleClassId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional articleClassId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
Articles_PutDangerousGoods: {
    parameters: {
        path: {
            articleSystemId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                dangerousGoodsCoefficient?: null | number;
                emsCode?: null | string;
                unIsMarineHazard?: boolean;
                unLabelNumbers?: null | string;
                unNumber: string;
                unPackageType?: null | string;
                unProperShippingNames?: null | {
                    languageCode?: null | string;
                    name?: null | string;
                }[];
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleSystemId?: null | number;
                    message?: null | string;
                };
            };
        };
    };
}

Update the dangerous goods info of an article. Note that the UN number must exist in Ongoing WMS before any articles can be set to that UN number.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
        };
    }
    • path: {
          articleSystemId: number;
      }
      • articleSystemId: number

        Description

        Article system ID for the article which the file is attached to.

  • requestBody: {
        content: {
            application/json: {
                dangerousGoodsCoefficient?: null | number;
                emsCode?: null | string;
                unIsMarineHazard?: boolean;
                unLabelNumbers?: null | string;
                unNumber: string;
                unPackageType?: null | string;
                unProperShippingNames?: null | {
                    languageCode?: null | string;
                    name?: null | string;
                }[];
            };
        };
    }

    Description

    Dangerous goods information.

    • content: {
          application/json: {
              dangerousGoodsCoefficient?: null | number;
              emsCode?: null | string;
              unIsMarineHazard?: boolean;
              unLabelNumbers?: null | string;
              unNumber: string;
              unPackageType?: null | string;
              unProperShippingNames?: null | {
                  languageCode?: null | string;
                  name?: null | string;
              }[];
          };
      }
      • application/json: {
            dangerousGoodsCoefficient?: null | number;
            emsCode?: null | string;
            unIsMarineHazard?: boolean;
            unLabelNumbers?: null | string;
            unNumber: string;
            unPackageType?: null | string;
            unProperShippingNames?: null | {
                languageCode?: null | string;
                name?: null | string;
            }[];
        }
        • Optional dangerousGoodsCoefficient?: null | number

          Format: decimal

        • Optional emsCode?: null | string
        • Optional unIsMarineHazard?: boolean
        • Optional unLabelNumbers?: null | string
        • unNumber: string
        • Optional unPackageType?: null | string
        • Optional unProperShippingNames?: null | {
              languageCode?: null | string;
              name?: null | string;
          }[]
  • responses: {
        200: {
            content: {
                application/json: {
                    articleSystemId?: null | number;
                    message?: null | string;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleSystemId?: null | number;
                  message?: null | string;
              };
          };
      }
      • content: {
            application/json: {
                articleSystemId?: null | number;
                message?: null | string;
            };
        }
        • application/json: {
              articleSystemId?: null | number;
              message?: null | string;
          }
          • Optional articleSystemId?: null | number

            Format: int32

          • Optional message?: null | string
Articles_PutDangerousGoodsByArticleNumber: {
    requestBody: {
        content: {
            application/json: {
                articleNumber: string;
                dangerousGoods: {
                    dangerousGoodsCoefficient?: null | number;
                    emsCode?: null | string;
                    unIsMarineHazard?: boolean;
                    unLabelNumbers?: null | string;
                    unNumber: string;
                    unPackageType?: null | string;
                    unProperShippingNames?: null | {
                        languageCode?: null | string;
                        name?: null | string;
                    }[];
                };
                goodsOwnerId: number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    articleSystemId?: null | number;
                    message?: null | string;
                };
            };
        };
    };
}

Update the dangerous goods info of an article via the article number.

Type declaration

  • requestBody: {
        content: {
            application/json: {
                articleNumber: string;
                dangerousGoods: {
                    dangerousGoodsCoefficient?: null | number;
                    emsCode?: null | string;
                    unIsMarineHazard?: boolean;
                    unLabelNumbers?: null | string;
                    unNumber: string;
                    unPackageType?: null | string;
                    unProperShippingNames?: null | {
                        languageCode?: null | string;
                        name?: null | string;
                    }[];
                };
                goodsOwnerId: number;
            };
        };
    }
    • content: {
          application/json: {
              articleNumber: string;
              dangerousGoods: {
                  dangerousGoodsCoefficient?: null | number;
                  emsCode?: null | string;
                  unIsMarineHazard?: boolean;
                  unLabelNumbers?: null | string;
                  unNumber: string;
                  unPackageType?: null | string;
                  unProperShippingNames?: null | {
                      languageCode?: null | string;
                      name?: null | string;
                  }[];
              };
              goodsOwnerId: number;
          };
      }
      • application/json: {
            articleNumber: string;
            dangerousGoods: {
                dangerousGoodsCoefficient?: null | number;
                emsCode?: null | string;
                unIsMarineHazard?: boolean;
                unLabelNumbers?: null | string;
                unNumber: string;
                unPackageType?: null | string;
                unProperShippingNames?: null | {
                    languageCode?: null | string;
                    name?: null | string;
                }[];
            };
            goodsOwnerId: number;
        }
        • articleNumber: string
        • dangerousGoods: {
              dangerousGoodsCoefficient?: null | number;
              emsCode?: null | string;
              unIsMarineHazard?: boolean;
              unLabelNumbers?: null | string;
              unNumber: string;
              unPackageType?: null | string;
              unProperShippingNames?: null | {
                  languageCode?: null | string;
                  name?: null | string;
              }[];
          }
          • Optional dangerousGoodsCoefficient?: null | number

            Format: decimal

          • Optional emsCode?: null | string
          • Optional unIsMarineHazard?: boolean
          • Optional unLabelNumbers?: null | string
          • unNumber: string
          • Optional unPackageType?: null | string
          • Optional unProperShippingNames?: null | {
                languageCode?: null | string;
                name?: null | string;
            }[]
        • goodsOwnerId: number

          Format: int32

  • responses: {
        200: {
            content: {
                application/json: {
                    articleSystemId?: null | number;
                    message?: null | string;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  articleSystemId?: null | number;
                  message?: null | string;
              };
          };
      }
      • content: {
            application/json: {
                articleSystemId?: null | number;
                message?: null | string;
            };
        }
        • application/json: {
              articleSystemId?: null | number;
              message?: null | string;
          }
          • Optional articleSystemId?: null | number

            Format: int32

          • Optional message?: null | string
Articles_PutFileUsingFilename: {
    parameters: {
        path: {
            articleSystemId: number;
        };
        query: {
            fileName: null | string;
        };
    };
    requestBody: {
        content: {
            application/json: {
                fileDataBase64: string;
                mimeType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Create or update a file which is attached to an article. The filename will be used to check if the file already exists.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
        };
        query: {
            fileName: null | string;
        };
    }
    • path: {
          articleSystemId: number;
      }
      • articleSystemId: number

        Description

        Article system ID for the article which the file is attached to.

    • query: {
          fileName: null | string;
      }
      • fileName: null | string

        Description

        File name.

  • requestBody: {
        content: {
            application/json: {
                fileDataBase64: string;
                mimeType: string;
            };
        };
    }

    Description

    File object, containing all file data.

    • content: {
          application/json: {
              fileDataBase64: string;
              mimeType: string;
          };
      }
      • application/json: {
            fileDataBase64: string;
            mimeType: string;
        }
        • fileDataBase64: string
        • mimeType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
Articles_SetArticleClasses: {
    parameters: {
        path: {
            articleSystemId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                articleClassIds: number[];
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Set the classes on an article.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
        };
    }
    • path: {
          articleSystemId: number;
      }
      • articleSystemId: number

        Description

        Article system ID.

  • requestBody: {
        content: {
            application/json: {
                articleClassIds: number[];
            };
        };
    }

    Description

    Contains the article class IDs.

    • content: {
          application/json: {
              articleClassIds: number[];
          };
      }
      • application/json: {
            articleClassIds: number[];
        }
        • articleClassIds: number[]
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
InventoryAdjustments_Get: {
    parameters: {
        path: {
            inventoryId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    article?: {
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        productCode?: null | string;
                    };
                    inventoryAdjustments?: null | {
                        articleItemComment?: null | string;
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batchNumber?: null | string;
                        expiryDate?: null | string;
                        inventoryAdjustmentCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        inventoryId?: number;
                        inventoryItemComment?: null | string;
                        inventoryTime?: string;
                        location?: null | string;
                        numberOfItems?: number;
                        serial?: null | string;
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    }[];
                };
            };
        };
    };
}

Get a specific inventory adjustment.

Type declaration

  • parameters: {
        path: {
            inventoryId: number;
        };
    }
    • path: {
          inventoryId: number;
      }
      • inventoryId: number

        Description

        The ID of the inventory adjustment.

  • responses: {
        200: {
            content: {
                application/json: {
                    article?: {
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        productCode?: null | string;
                    };
                    inventoryAdjustments?: null | {
                        articleItemComment?: null | string;
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batchNumber?: null | string;
                        expiryDate?: null | string;
                        inventoryAdjustmentCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        inventoryId?: number;
                        inventoryItemComment?: null | string;
                        inventoryTime?: string;
                        location?: null | string;
                        numberOfItems?: number;
                        serial?: null | string;
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  article?: {
                      articleName?: null | string;
                      articleNumber?: null | string;
                      articleSystemId?: number;
                      productCode?: null | string;
                  };
                  inventoryAdjustments?: null | {
                      articleItemComment?: null | string;
                      articleItemStatus?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      batchNumber?: null | string;
                      expiryDate?: null | string;
                      inventoryAdjustmentCause?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      inventoryId?: number;
                      inventoryItemComment?: null | string;
                      inventoryTime?: string;
                      location?: null | string;
                      numberOfItems?: number;
                      serial?: null | string;
                      warehouse?: {
                          code?: null | string;
                          id?: number;
                          name?: null | string;
                      };
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                article?: {
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    productCode?: null | string;
                };
                inventoryAdjustments?: null | {
                    articleItemComment?: null | string;
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    batchNumber?: null | string;
                    expiryDate?: null | string;
                    inventoryAdjustmentCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    inventoryId?: number;
                    inventoryItemComment?: null | string;
                    inventoryTime?: string;
                    location?: null | string;
                    numberOfItems?: number;
                    serial?: null | string;
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                }[];
            };
        }
        • application/json: {
              article?: {
                  articleName?: null | string;
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  productCode?: null | string;
              };
              inventoryAdjustments?: null | {
                  articleItemComment?: null | string;
                  articleItemStatus?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  batchNumber?: null | string;
                  expiryDate?: null | string;
                  inventoryAdjustmentCause?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  inventoryId?: number;
                  inventoryItemComment?: null | string;
                  inventoryTime?: string;
                  location?: null | string;
                  numberOfItems?: number;
                  serial?: null | string;
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
              }[];
          }
          • Optional article?: {
                articleName?: null | string;
                articleNumber?: null | string;
                articleSystemId?: number;
                productCode?: null | string;
            }
            • Optional articleName?: null | string
            • Optional articleNumber?: null | string
            • Optional articleSystemId?: number

              Format: int32

            • Optional productCode?: null | string
          • Optional inventoryAdjustments?: null | {
                articleItemComment?: null | string;
                articleItemStatus?: {
                    code?: null | string;
                    name?: null | string;
                };
                batchNumber?: null | string;
                expiryDate?: null | string;
                inventoryAdjustmentCause?: {
                    code?: null | string;
                    name?: null | string;
                };
                inventoryId?: number;
                inventoryItemComment?: null | string;
                inventoryTime?: string;
                location?: null | string;
                numberOfItems?: number;
                serial?: null | string;
                warehouse?: {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                };
            }[]
InventoryAdjustments_GetAll: {
    parameters: {
        query: {
            from?: null | string;
            goodsOwnerId: number;
            isReported?: null | boolean;
            to?: null | string;
            toTime?: null | string;
        };
    };
    requestBody: {
        content: {
            application/json: {
                article?: {
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    productCode?: null | string;
                };
                inventoryAdjustments?: null | {
                    articleItemComment?: null | string;
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    batchNumber?: null | string;
                    expiryDate?: null | string;
                    inventoryAdjustmentCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    inventoryId?: number;
                    inventoryItemComment?: null | string;
                    inventoryTime?: string;
                    location?: null | string;
                    numberOfItems?: number;
                    serial?: null | string;
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                }[];
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    article?: {
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        productCode?: null | string;
                    };
                    inventoryAdjustments?: null | {
                        articleItemComment?: null | string;
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batchNumber?: null | string;
                        expiryDate?: null | string;
                        inventoryAdjustmentCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        inventoryId?: number;
                        inventoryItemComment?: null | string;
                        inventoryTime?: string;
                        location?: null | string;
                        numberOfItems?: number;
                        serial?: null | string;
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    }[];
                }[];
            };
        };
    };
}

Get all inventory adjustments which match the specified search criteria.

Type declaration

  • parameters: {
        query: {
            from?: null | string;
            goodsOwnerId: number;
            isReported?: null | boolean;
            to?: null | string;
            toTime?: null | string;
        };
    }
    • query: {
          from?: null | string;
          goodsOwnerId: number;
          isReported?: null | boolean;
          to?: null | string;
          toTime?: null | string;
      }
      • Optional from?: null | string

        Description

        The 'from' time. If specified, returns inventory adjustments which were made after this time.

      • goodsOwnerId: number

        Description

        Goods owner ID.

      • Optional isReported?: null | boolean

        Description

        Only return inventory adjustments which have not been marked as 'reported'.

      • Optional to?: null | string

        Description

        Obsolete, do not use.

      • Optional toTime?: null | string

        Description

        The 'to' time. If specified, returns inventory adjustments which were made before this time.

  • requestBody: {
        content: {
            application/json: {
                article?: {
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    productCode?: null | string;
                };
                inventoryAdjustments?: null | {
                    articleItemComment?: null | string;
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    batchNumber?: null | string;
                    expiryDate?: null | string;
                    inventoryAdjustmentCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    inventoryId?: number;
                    inventoryItemComment?: null | string;
                    inventoryTime?: string;
                    location?: null | string;
                    numberOfItems?: number;
                    serial?: null | string;
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                }[];
            };
        };
    }

    Description

    An object containing the inventory adjustment class type data.

    • content: {
          application/json: {
              article?: {
                  articleName?: null | string;
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  productCode?: null | string;
              };
              inventoryAdjustments?: null | {
                  articleItemComment?: null | string;
                  articleItemStatus?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  batchNumber?: null | string;
                  expiryDate?: null | string;
                  inventoryAdjustmentCause?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  inventoryId?: number;
                  inventoryItemComment?: null | string;
                  inventoryTime?: string;
                  location?: null | string;
                  numberOfItems?: number;
                  serial?: null | string;
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
              }[];
          };
      }
      • application/json: {
            article?: {
                articleName?: null | string;
                articleNumber?: null | string;
                articleSystemId?: number;
                productCode?: null | string;
            };
            inventoryAdjustments?: null | {
                articleItemComment?: null | string;
                articleItemStatus?: {
                    code?: null | string;
                    name?: null | string;
                };
                batchNumber?: null | string;
                expiryDate?: null | string;
                inventoryAdjustmentCause?: {
                    code?: null | string;
                    name?: null | string;
                };
                inventoryId?: number;
                inventoryItemComment?: null | string;
                inventoryTime?: string;
                location?: null | string;
                numberOfItems?: number;
                serial?: null | string;
                warehouse?: {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                };
            }[];
        }
        • Optional article?: {
              articleName?: null | string;
              articleNumber?: null | string;
              articleSystemId?: number;
              productCode?: null | string;
          }
          • Optional articleName?: null | string
          • Optional articleNumber?: null | string
          • Optional articleSystemId?: number

            Format: int32

          • Optional productCode?: null | string
        • Optional inventoryAdjustments?: null | {
              articleItemComment?: null | string;
              articleItemStatus?: {
                  code?: null | string;
                  name?: null | string;
              };
              batchNumber?: null | string;
              expiryDate?: null | string;
              inventoryAdjustmentCause?: {
                  code?: null | string;
                  name?: null | string;
              };
              inventoryId?: number;
              inventoryItemComment?: null | string;
              inventoryTime?: string;
              location?: null | string;
              numberOfItems?: number;
              serial?: null | string;
              warehouse?: {
                  code?: null | string;
                  id?: number;
                  name?: null | string;
              };
          }[]
  • responses: {
        200: {
            content: {
                application/json: null | {
                    article?: {
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        productCode?: null | string;
                    };
                    inventoryAdjustments?: null | {
                        articleItemComment?: null | string;
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batchNumber?: null | string;
                        expiryDate?: null | string;
                        inventoryAdjustmentCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        inventoryId?: number;
                        inventoryItemComment?: null | string;
                        inventoryTime?: string;
                        location?: null | string;
                        numberOfItems?: number;
                        serial?: null | string;
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    }[];
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  article?: {
                      articleName?: null | string;
                      articleNumber?: null | string;
                      articleSystemId?: number;
                      productCode?: null | string;
                  };
                  inventoryAdjustments?: null | {
                      articleItemComment?: null | string;
                      articleItemStatus?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      batchNumber?: null | string;
                      expiryDate?: null | string;
                      inventoryAdjustmentCause?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      inventoryId?: number;
                      inventoryItemComment?: null | string;
                      inventoryTime?: string;
                      location?: null | string;
                      numberOfItems?: number;
                      serial?: null | string;
                      warehouse?: {
                          code?: null | string;
                          id?: number;
                          name?: null | string;
                      };
                  }[];
              }[];
          };
      }
      • content: {
            application/json: null | {
                article?: {
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    productCode?: null | string;
                };
                inventoryAdjustments?: null | {
                    articleItemComment?: null | string;
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    batchNumber?: null | string;
                    expiryDate?: null | string;
                    inventoryAdjustmentCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    inventoryId?: number;
                    inventoryItemComment?: null | string;
                    inventoryTime?: string;
                    location?: null | string;
                    numberOfItems?: number;
                    serial?: null | string;
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                }[];
            }[];
        }
        • application/json: null | {
              article?: {
                  articleName?: null | string;
                  articleNumber?: null | string;
                  articleSystemId?: number;
                  productCode?: null | string;
              };
              inventoryAdjustments?: null | {
                  articleItemComment?: null | string;
                  articleItemStatus?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  batchNumber?: null | string;
                  expiryDate?: null | string;
                  inventoryAdjustmentCause?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  inventoryId?: number;
                  inventoryItemComment?: null | string;
                  inventoryTime?: string;
                  location?: null | string;
                  numberOfItems?: number;
                  serial?: null | string;
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
              }[];
          }[]
InventoryAdjustments_PatchInventoryAdjustmentArticlesReported: {
    parameters: {
        path: {
            articleSystemId: number;
            inventoryId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    items?: null | {
                        articleItemId?: number;
                        inventoryArticleItemId?: number;
                    }[];
                    message?: null | string;
                };
            };
        };
    };
}

Sets the 'reported' flag on an inventory to true for the specified article.

Type declaration

  • parameters: {
        path: {
            articleSystemId: number;
            inventoryId: number;
        };
    }
    • path: {
          articleSystemId: number;
          inventoryId: number;
      }
      • articleSystemId: number

        Description

        Article system ID.

      • inventoryId: number

        Description

        Inventory ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    items?: null | {
                        articleItemId?: number;
                        inventoryArticleItemId?: number;
                    }[];
                    message?: null | string;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  items?: null | {
                      articleItemId?: number;
                      inventoryArticleItemId?: number;
                  }[];
                  message?: null | string;
              };
          };
      }
      • content: {
            application/json: {
                items?: null | {
                    articleItemId?: number;
                    inventoryArticleItemId?: number;
                }[];
                message?: null | string;
            };
        }
        • application/json: {
              items?: null | {
                  articleItemId?: number;
                  inventoryArticleItemId?: number;
              }[];
              message?: null | string;
          }
          • Optional items?: null | {
                articleItemId?: number;
                inventoryArticleItemId?: number;
            }[]
          • Optional message?: null | string
Orders_Delete: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
    };
}

Cancel an order. You can only cancel an order if the warehouse has not started working on it.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: null | number;
          }
          • Optional message?: null | string
          • Optional orderId?: null | number

            Format: int32

Orders_DeleteByOrderNumber: {
    parameters: {
        query: {
            goodsOwnerId: number;
            orderNumber: null | string;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
    };
}

Cancel an order using the order number. You can only cancel an order if the warehouse has not started working on it.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
            orderNumber: null | string;
        };
    }
    • query: {
          goodsOwnerId: number;
          orderNumber: null | string;
      }
      • goodsOwnerId: number

        Description

        Goods owner ID.

      • orderNumber: null | string

        Description

        Order number.

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: null | number;
          }
          • Optional message?: null | string
          • Optional orderId?: null | number

            Format: int32

Orders_DeleteParcel: {
    parameters: {
        path: {
            orderId: number;
            parcelId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    parcelId?: number;
                    success?: boolean;
                };
            };
        };
    };
}

Deletes a parcel. A parcel can only be deleted if it is empty.

Type declaration

  • parameters: {
        path: {
            orderId: number;
            parcelId: number;
        };
    }
    • path: {
          orderId: number;
          parcelId: number;
      }
      • orderId: number

        Description

        Order ID.

      • parcelId: number

        Description

        Parcel ID

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    parcelId?: number;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  parcelId?: number;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                parcelId?: number;
                success?: boolean;
            };
        }
        • application/json: {
              message?: null | string;
              parcelId?: number;
              success?: boolean;
          }
          • Optional message?: null | string
          • Optional parcelId?: number

            Format: int32

          • Optional success?: boolean
Orders_DeleteWayOfDeliveryType: {
    parameters: {
        path: {
            wayOfDeliveryTypeId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayOfDeliveryTypeId?: null | number;
                };
            };
        };
    };
}

Delete a way of delivery type.

Type declaration

  • parameters: {
        path: {
            wayOfDeliveryTypeId: number;
        };
    }
    • path: {
          wayOfDeliveryTypeId: number;
      }
      • wayOfDeliveryTypeId: number

        Description

        Way of delivery type ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayOfDeliveryTypeId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  success?: boolean;
                  wayOfDeliveryTypeId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                success?: boolean;
                wayOfDeliveryTypeId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              success?: boolean;
              wayOfDeliveryTypeId?: null | number;
          }
          • Optional message?: null | string
          • Optional success?: boolean
          • Optional wayOfDeliveryTypeId?: null | number

            Format: int32

Orders_DeleteWaybillRow: {
    parameters: {
        path: {
            orderId: number;
            wayBillRowId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    parcelId?: number;
                    success?: boolean;
                };
            };
        };
    };
}

Deletes a waybill row.

Type declaration

  • parameters: {
        path: {
            orderId: number;
            wayBillRowId: number;
        };
    }
    • path: {
          orderId: number;
          wayBillRowId: number;
      }
      • orderId: number

        Description

        Order ID.

      • wayBillRowId: number

        Description

        Waybill row ID

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    parcelId?: number;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  parcelId?: number;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                parcelId?: number;
                success?: boolean;
            };
        }
        • application/json: {
              message?: null | string;
              parcelId?: number;
              success?: boolean;
          }
          • Optional message?: null | string
          • Optional parcelId?: number

            Format: int32

          • Optional success?: boolean
Orders_Get: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    classes?: null | ({
                        code?: null | string;
                        name?: null | string;
                    } & Record<string, never>)[];
                    consignee?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                            smsNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        customerNumber?: null | string;
                        doorCode?: null | string;
                        id?: number;
                        invoiceAddress?: {
                            address1?: null | string;
                            address2?: null | string;
                            address3?: null | string;
                            advanced?: {
                                emailNotification?: {
                                    value?: null | string;
                                };
                                smsNotification?: {
                                    value?: null | string;
                                };
                                telephoneNotification?: {
                                    value?: null | string;
                                };
                            };
                            city?: null | string;
                            countryCode?: null | string;
                            countryStateCode?: null | string;
                            name?: null | string;
                            postCode?: null | string;
                        };
                        name?: null | string;
                        postCode?: null | string;
                        remark?: null | string;
                    };
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    orderInfo?: {
                        advanced?: {
                            arrivalDate?: null | string;
                            backOrderInfo?: {
                                backOrderForOrderId?: number;
                            };
                            deliveryDateWithTime?: string;
                            invoiceNumber?: null | string;
                        };
                        allocatedNumberOfItems?: number;
                        consigneeOrderNumber?: null | string;
                        createdDate?: string;
                        customerPrice?: null | number;
                        customsInfo?: {
                            customsValueCurrencyCode?: null | string;
                        };
                        deliveryDate?: string;
                        deliveryInstruction?: null | string;
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        freeText1?: null | string;
                        freeText2?: null | string;
                        freeText3?: null | string;
                        goodsOwnerOrderId?: null | string;
                        marketPlace?: {
                            marketPlace?: null | string;
                            marketPlaceOrderNumber?: null | string;
                        };
                        orderId?: number;
                        orderNumber?: null | string;
                        orderRemark?: null | string;
                        orderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        orderType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        orderedNumberOfItems?: number;
                        pickedNumberOfItems?: number;
                        pickingPriority?: null | number;
                        preparedTransportDocumentId?: null | string;
                        productionCode?: null | string;
                        referenceNumber?: null | string;
                        returnWayBill?: null | string;
                        salesCode?: null | string;
                        servicePointCode?: null | string;
                        shippedTime?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        termsOfDeliveryType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                        warehouseInstruction?: null | string;
                        wayBill?: null | string;
                        wayOfDelivery?: {
                            code?: null | string;
                            name?: null | string;
                        };
                    };
                    orderLines?: null | {
                        allocatedNumberOfItems?: number;
                        article?: {
                            articleKind?: null | string;
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                            productCode?: null | string;
                        };
                        batchNumber?: null | string;
                        comment?: null | string;
                        customerArticleNumber?: null | string;
                        externalId?: null | string;
                        freeValues?: {
                            freeText1?: null | string;
                        };
                        id?: number;
                        lineTotalCustomsValue?: null | number;
                        lineType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        orderedNumberOfItems?: number;
                        packedNumberOfItems?: number;
                        pickedArticleItems?: null | {
                            articleItemId?: number;
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batchNumber?: null | string;
                            caseNumber?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            freeText1?: null | string;
                            handling?: {
                                packedByUserId?: null | number;
                                pickedByUserId?: null | number;
                            };
                            inDate?: string;
                            isPicked?: boolean;
                            isReturned?: boolean;
                            location?: null | string;
                            locationTypeCode?: null | string;
                            numberOfItems?: number;
                            packedTime?: null | string;
                            parcel?: {
                                advanced?: {
                                    parcelSerialNumber?: null | string;
                                };
                                id?: number;
                                parcelNumber?: null | string;
                                parcelType?: {
                                    code?: null | string;
                                };
                                parentParcel?: {
                                    advanced?: {
                                        parcelSerialNumber?: null | string;
                                    };
                                    id?: number;
                                    parcelNumber?: null | string;
                                    parcelType?: {
                                        code?: null | string;
                                    };
                                };
                            };
                            pickedTime?: null | string;
                            returnCause?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            returnDate?: null | string;
                            serial?: null | string;
                            volume?: null | number;
                            weight?: null | number;
                            zoneName?: null | string;
                        }[];
                        pickedNumberOfItems?: number;
                        prices?: {
                            currencyCode?: null | string;
                            customerLinePrice?: null | number;
                            discountPercentage?: null | number;
                            linePrice?: null | number;
                        };
                        reportedNumberOfItems?: null | number;
                        reportedReturnedNumberOfItems?: null | number;
                        returnedNumberOfItems?: number;
                        rowNumber?: null | string;
                        serialNumber?: null | string;
                        shouldBePicked?: boolean;
                        subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
                    }[];
                    parcels?: null | {
                        advanced?: {
                            parcelSerialNumber?: null | string;
                        };
                        id?: number;
                        isReturnParcel?: boolean;
                        parcelNumber?: null | string;
                        tracking?: {
                            trackingUrl?: null | string;
                        };
                    }[];
                    returnTransporter?: {
                        code?: null | string;
                        name?: null | string;
                        serviceCode?: null | string;
                        serviceComment?: null | string;
                        transporterContract?: {
                            comment?: null | string;
                        };
                        transporterName?: null | string;
                    };
                    shipmentInfo?: {
                        shipmentId?: number;
                    };
                    tracking?: null | {
                        created?: string;
                        trackingUrl?: null | string;
                        waybill?: null | string;
                    }[];
                    transporter?: {
                        code?: null | string;
                        name?: null | string;
                        serviceCode?: null | string;
                        serviceComment?: null | string;
                        transporterContract?: {
                            comment?: null | string;
                        };
                        transporterName?: null | string;
                    };
                };
            };
        };
    };
}

Get an order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    classes?: null | ({
                        code?: null | string;
                        name?: null | string;
                    } & Record<string, never>)[];
                    consignee?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                            smsNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        customerNumber?: null | string;
                        doorCode?: null | string;
                        id?: number;
                        invoiceAddress?: {
                            address1?: null | string;
                            address2?: null | string;
                            address3?: null | string;
                            advanced?: {
                                emailNotification?: {
                                    value?: null | string;
                                };
                                smsNotification?: {
                                    value?: null | string;
                                };
                                telephoneNotification?: {
                                    value?: null | string;
                                };
                            };
                            city?: null | string;
                            countryCode?: null | string;
                            countryStateCode?: null | string;
                            name?: null | string;
                            postCode?: null | string;
                        };
                        name?: null | string;
                        postCode?: null | string;
                        remark?: null | string;
                    };
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    orderInfo?: {
                        advanced?: {
                            arrivalDate?: null | string;
                            backOrderInfo?: {
                                backOrderForOrderId?: number;
                            };
                            deliveryDateWithTime?: string;
                            invoiceNumber?: null | string;
                        };
                        allocatedNumberOfItems?: number;
                        consigneeOrderNumber?: null | string;
                        createdDate?: string;
                        customerPrice?: null | number;
                        customsInfo?: {
                            customsValueCurrencyCode?: null | string;
                        };
                        deliveryDate?: string;
                        deliveryInstruction?: null | string;
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        freeText1?: null | string;
                        freeText2?: null | string;
                        freeText3?: null | string;
                        goodsOwnerOrderId?: null | string;
                        marketPlace?: {
                            marketPlace?: null | string;
                            marketPlaceOrderNumber?: null | string;
                        };
                        orderId?: number;
                        orderNumber?: null | string;
                        orderRemark?: null | string;
                        orderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        orderType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        orderedNumberOfItems?: number;
                        pickedNumberOfItems?: number;
                        pickingPriority?: null | number;
                        preparedTransportDocumentId?: null | string;
                        productionCode?: null | string;
                        referenceNumber?: null | string;
                        returnWayBill?: null | string;
                        salesCode?: null | string;
                        servicePointCode?: null | string;
                        shippedTime?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        termsOfDeliveryType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                        warehouseInstruction?: null | string;
                        wayBill?: null | string;
                        wayOfDelivery?: {
                            code?: null | string;
                            name?: null | string;
                        };
                    };
                    orderLines?: null | {
                        allocatedNumberOfItems?: number;
                        article?: {
                            articleKind?: null | string;
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                            productCode?: null | string;
                        };
                        batchNumber?: null | string;
                        comment?: null | string;
                        customerArticleNumber?: null | string;
                        externalId?: null | string;
                        freeValues?: {
                            freeText1?: null | string;
                        };
                        id?: number;
                        lineTotalCustomsValue?: null | number;
                        lineType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        orderedNumberOfItems?: number;
                        packedNumberOfItems?: number;
                        pickedArticleItems?: null | {
                            articleItemId?: number;
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batchNumber?: null | string;
                            caseNumber?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            freeText1?: null | string;
                            handling?: {
                                packedByUserId?: null | number;
                                pickedByUserId?: null | number;
                            };
                            inDate?: string;
                            isPicked?: boolean;
                            isReturned?: boolean;
                            location?: null | string;
                            locationTypeCode?: null | string;
                            numberOfItems?: number;
                            packedTime?: null | string;
                            parcel?: {
                                advanced?: {
                                    parcelSerialNumber?: null | string;
                                };
                                id?: number;
                                parcelNumber?: null | string;
                                parcelType?: {
                                    code?: null | string;
                                };
                                parentParcel?: {
                                    advanced?: {
                                        parcelSerialNumber?: null | string;
                                    };
                                    id?: number;
                                    parcelNumber?: null | string;
                                    parcelType?: {
                                        code?: null | string;
                                    };
                                };
                            };
                            pickedTime?: null | string;
                            returnCause?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            returnDate?: null | string;
                            serial?: null | string;
                            volume?: null | number;
                            weight?: null | number;
                            zoneName?: null | string;
                        }[];
                        pickedNumberOfItems?: number;
                        prices?: {
                            currencyCode?: null | string;
                            customerLinePrice?: null | number;
                            discountPercentage?: null | number;
                            linePrice?: null | number;
                        };
                        reportedNumberOfItems?: null | number;
                        reportedReturnedNumberOfItems?: null | number;
                        returnedNumberOfItems?: number;
                        rowNumber?: null | string;
                        serialNumber?: null | string;
                        shouldBePicked?: boolean;
                        subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
                    }[];
                    parcels?: null | {
                        advanced?: {
                            parcelSerialNumber?: null | string;
                        };
                        id?: number;
                        isReturnParcel?: boolean;
                        parcelNumber?: null | string;
                        tracking?: {
                            trackingUrl?: null | string;
                        };
                    }[];
                    returnTransporter?: {
                        code?: null | string;
                        name?: null | string;
                        serviceCode?: null | string;
                        serviceComment?: null | string;
                        transporterContract?: {
                            comment?: null | string;
                        };
                        transporterName?: null | string;
                    };
                    shipmentInfo?: {
                        shipmentId?: number;
                    };
                    tracking?: null | {
                        created?: string;
                        trackingUrl?: null | string;
                        waybill?: null | string;
                    }[];
                    transporter?: {
                        code?: null | string;
                        name?: null | string;
                        serviceCode?: null | string;
                        serviceComment?: null | string;
                        transporterContract?: {
                            comment?: null | string;
                        };
                        transporterName?: null | string;
                    };
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  classes?: null | ({
                      code?: null | string;
                      name?: null | string;
                  } & Record<string, never>)[];
                  consignee?: {
                      address1?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      advanced?: {
                          emailNotification?: {
                              toBeNotified?: boolean;
                              value?: null | string;
                          };
                          smsNotification?: {
                              toBeNotified?: boolean;
                              value?: null | string;
                          };
                          telephoneNotification?: {
                              toBeNotified?: boolean;
                              value?: null | string;
                          };
                      };
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      customerNumber?: null | string;
                      doorCode?: null | string;
                      id?: number;
                      invoiceAddress?: {
                          address1?: null | string;
                          address2?: null | string;
                          address3?: null | string;
                          advanced?: {
                              emailNotification?: {
                                  value?: null | string;
                              };
                              smsNotification?: {
                                  value?: null | string;
                              };
                              telephoneNotification?: {
                                  value?: null | string;
                              };
                          };
                          city?: null | string;
                          countryCode?: null | string;
                          countryStateCode?: null | string;
                          name?: null | string;
                          postCode?: null | string;
                      };
                      name?: null | string;
                      postCode?: null | string;
                      remark?: null | string;
                  };
                  goodsOwner?: {
                      id?: number;
                      name?: null | string;
                  };
                  orderInfo?: {
                      advanced?: {
                          arrivalDate?: null | string;
                          backOrderInfo?: {
                              backOrderForOrderId?: number;
                          };
                          deliveryDateWithTime?: string;
                          invoiceNumber?: null | string;
                      };
                      allocatedNumberOfItems?: number;
                      consigneeOrderNumber?: null | string;
                      createdDate?: string;
                      customerPrice?: null | number;
                      customsInfo?: {
                          customsValueCurrencyCode?: null | string;
                      };
                      deliveryDate?: string;
                      deliveryInstruction?: null | string;
                      emailNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      freeText1?: null | string;
                      freeText2?: null | string;
                      freeText3?: null | string;
                      goodsOwnerOrderId?: null | string;
                      marketPlace?: {
                          marketPlace?: null | string;
                          marketPlaceOrderNumber?: null | string;
                      };
                      orderId?: number;
                      orderNumber?: null | string;
                      orderRemark?: null | string;
                      orderStatus?: {
                          number?: number;
                          text?: null | string;
                      };
                      orderType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      orderedNumberOfItems?: number;
                      pickedNumberOfItems?: number;
                      pickingPriority?: null | number;
                      preparedTransportDocumentId?: null | string;
                      productionCode?: null | string;
                      referenceNumber?: null | string;
                      returnWayBill?: null | string;
                      salesCode?: null | string;
                      servicePointCode?: null | string;
                      shippedTime?: null | string;
                      smsNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      termsOfDeliveryType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      warehouse?: {
                          code?: null | string;
                          id?: number;
                          name?: null | string;
                      };
                      warehouseInstruction?: null | string;
                      wayBill?: null | string;
                      wayOfDelivery?: {
                          code?: null | string;
                          name?: null | string;
                      };
                  };
                  orderLines?: null | {
                      allocatedNumberOfItems?: number;
                      article?: {
                          articleKind?: null | string;
                          articleName?: null | string;
                          articleNumber?: null | string;
                          articleSystemId?: number;
                          productCode?: null | string;
                      };
                      batchNumber?: null | string;
                      comment?: null | string;
                      customerArticleNumber?: null | string;
                      externalId?: null | string;
                      freeValues?: {
                          freeText1?: null | string;
                      };
                      id?: number;
                      lineTotalCustomsValue?: null | number;
                      lineType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      orderedNumberOfItems?: number;
                      packedNumberOfItems?: number;
                      pickedArticleItems?: null | {
                          articleItemId?: number;
                          articleItemStatus?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          batchNumber?: null | string;
                          caseNumber?: null | string;
                          comment?: null | string;
                          container?: null | string;
                          expiryDate?: null | string;
                          freeText1?: null | string;
                          handling?: {
                              packedByUserId?: null | number;
                              pickedByUserId?: null | number;
                          };
                          inDate?: string;
                          isPicked?: boolean;
                          isReturned?: boolean;
                          location?: null | string;
                          locationTypeCode?: null | string;
                          numberOfItems?: number;
                          packedTime?: null | string;
                          parcel?: {
                              advanced?: {
                                  parcelSerialNumber?: null | string;
                              };
                              id?: number;
                              parcelNumber?: null | string;
                              parcelType?: {
                                  code?: null | string;
                              };
                              parentParcel?: {
                                  advanced?: {
                                      parcelSerialNumber?: null | string;
                                  };
                                  id?: number;
                                  parcelNumber?: null | string;
                                  parcelType?: {
                                      code?: null | string;
                                  };
                              };
                          };
                          pickedTime?: null | string;
                          returnCause?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          returnDate?: null | string;
                          serial?: null | string;
                          volume?: null | number;
                          weight?: null | number;
                          zoneName?: null | string;
                      }[];
                      pickedNumberOfItems?: number;
                      prices?: {
                          currencyCode?: null | string;
                          customerLinePrice?: null | number;
                          discountPercentage?: null | number;
                          linePrice?: null | number;
                      };
                      reportedNumberOfItems?: null | number;
                      reportedReturnedNumberOfItems?: null | number;
                      returnedNumberOfItems?: number;
                      rowNumber?: null | string;
                      serialNumber?: null | string;
                      shouldBePicked?: boolean;
                      subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
                  }[];
                  parcels?: null | {
                      advanced?: {
                          parcelSerialNumber?: null | string;
                      };
                      id?: number;
                      isReturnParcel?: boolean;
                      parcelNumber?: null | string;
                      tracking?: {
                          trackingUrl?: null | string;
                      };
                  }[];
                  returnTransporter?: {
                      code?: null | string;
                      name?: null | string;
                      serviceCode?: null | string;
                      serviceComment?: null | string;
                      transporterContract?: {
                          comment?: null | string;
                      };
                      transporterName?: null | string;
                  };
                  shipmentInfo?: {
                      shipmentId?: number;
                  };
                  tracking?: null | {
                      created?: string;
                      trackingUrl?: null | string;
                      waybill?: null | string;
                  }[];
                  transporter?: {
                      code?: null | string;
                      name?: null | string;
                      serviceCode?: null | string;
                      serviceComment?: null | string;
                      transporterContract?: {
                          comment?: null | string;
                      };
                      transporterName?: null | string;
                  };
              };
          };
      }
      • content: {
            application/json: {
                classes?: null | ({
                    code?: null | string;
                    name?: null | string;
                } & Record<string, never>)[];
                consignee?: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    advanced?: {
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                    };
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    customerNumber?: null | string;
                    doorCode?: null | string;
                    id?: number;
                    invoiceAddress?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                value?: null | string;
                            };
                            smsNotification?: {
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        name?: null | string;
                        postCode?: null | string;
                    };
                    name?: null | string;
                    postCode?: null | string;
                    remark?: null | string;
                };
                goodsOwner?: {
                    id?: number;
                    name?: null | string;
                };
                orderInfo?: {
                    advanced?: {
                        arrivalDate?: null | string;
                        backOrderInfo?: {
                            backOrderForOrderId?: number;
                        };
                        deliveryDateWithTime?: string;
                        invoiceNumber?: null | string;
                    };
                    allocatedNumberOfItems?: number;
                    consigneeOrderNumber?: null | string;
                    createdDate?: string;
                    customerPrice?: null | number;
                    customsInfo?: {
                        customsValueCurrencyCode?: null | string;
                    };
                    deliveryDate?: string;
                    deliveryInstruction?: null | string;
                    emailNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    freeText1?: null | string;
                    freeText2?: null | string;
                    freeText3?: null | string;
                    goodsOwnerOrderId?: null | string;
                    marketPlace?: {
                        marketPlace?: null | string;
                        marketPlaceOrderNumber?: null | string;
                    };
                    orderId?: number;
                    orderNumber?: null | string;
                    orderRemark?: null | string;
                    orderStatus?: {
                        number?: number;
                        text?: null | string;
                    };
                    orderType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    orderedNumberOfItems?: number;
                    pickedNumberOfItems?: number;
                    pickingPriority?: null | number;
                    preparedTransportDocumentId?: null | string;
                    productionCode?: null | string;
                    referenceNumber?: null | string;
                    returnWayBill?: null | string;
                    salesCode?: null | string;
                    servicePointCode?: null | string;
                    shippedTime?: null | string;
                    smsNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    telephoneNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    termsOfDeliveryType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                    warehouseInstruction?: null | string;
                    wayBill?: null | string;
                    wayOfDelivery?: {
                        code?: null | string;
                        name?: null | string;
                    };
                };
                orderLines?: null | {
                    allocatedNumberOfItems?: number;
                    article?: {
                        articleKind?: null | string;
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        productCode?: null | string;
                    };
                    batchNumber?: null | string;
                    comment?: null | string;
                    customerArticleNumber?: null | string;
                    externalId?: null | string;
                    freeValues?: {
                        freeText1?: null | string;
                    };
                    id?: number;
                    lineTotalCustomsValue?: null | number;
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    orderedNumberOfItems?: number;
                    packedNumberOfItems?: number;
                    pickedArticleItems?: null | {
                        articleItemId?: number;
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batchNumber?: null | string;
                        caseNumber?: null | string;
                        comment?: null | string;
                        container?: null | string;
                        expiryDate?: null | string;
                        freeText1?: null | string;
                        handling?: {
                            packedByUserId?: null | number;
                            pickedByUserId?: null | number;
                        };
                        inDate?: string;
                        isPicked?: boolean;
                        isReturned?: boolean;
                        location?: null | string;
                        locationTypeCode?: null | string;
                        numberOfItems?: number;
                        packedTime?: null | string;
                        parcel?: {
                            advanced?: {
                                parcelSerialNumber?: null | string;
                            };
                            id?: number;
                            parcelNumber?: null | string;
                            parcelType?: {
                                code?: null | string;
                            };
                            parentParcel?: {
                                advanced?: {
                                    parcelSerialNumber?: null | string;
                                };
                                id?: number;
                                parcelNumber?: null | string;
                                parcelType?: {
                                    code?: null | string;
                                };
                            };
                        };
                        pickedTime?: null | string;
                        returnCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        returnDate?: null | string;
                        serial?: null | string;
                        volume?: null | number;
                        weight?: null | number;
                        zoneName?: null | string;
                    }[];
                    pickedNumberOfItems?: number;
                    prices?: {
                        currencyCode?: null | string;
                        customerLinePrice?: null | number;
                        discountPercentage?: null | number;
                        linePrice?: null | number;
                    };
                    reportedNumberOfItems?: null | number;
                    reportedReturnedNumberOfItems?: null | number;
                    returnedNumberOfItems?: number;
                    rowNumber?: null | string;
                    serialNumber?: null | string;
                    shouldBePicked?: boolean;
                    subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
                }[];
                parcels?: null | {
                    advanced?: {
                        parcelSerialNumber?: null | string;
                    };
                    id?: number;
                    isReturnParcel?: boolean;
                    parcelNumber?: null | string;
                    tracking?: {
                        trackingUrl?: null | string;
                    };
                }[];
                returnTransporter?: {
                    code?: null | string;
                    name?: null | string;
                    serviceCode?: null | string;
                    serviceComment?: null | string;
                    transporterContract?: {
                        comment?: null | string;
                    };
                    transporterName?: null | string;
                };
                shipmentInfo?: {
                    shipmentId?: number;
                };
                tracking?: null | {
                    created?: string;
                    trackingUrl?: null | string;
                    waybill?: null | string;
                }[];
                transporter?: {
                    code?: null | string;
                    name?: null | string;
                    serviceCode?: null | string;
                    serviceComment?: null | string;
                    transporterContract?: {
                        comment?: null | string;
                    };
                    transporterName?: null | string;
                };
            };
        }
        • application/json: {
              classes?: null | ({
                  code?: null | string;
                  name?: null | string;
              } & Record<string, never>)[];
              consignee?: {
                  address1?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  advanced?: {
                      emailNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      smsNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                  };
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  customerNumber?: null | string;
                  doorCode?: null | string;
                  id?: number;
                  invoiceAddress?: {
                      address1?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      advanced?: {
                          emailNotification?: {
                              value?: null | string;
                          };
                          smsNotification?: {
                              value?: null | string;
                          };
                          telephoneNotification?: {
                              value?: null | string;
                          };
                      };
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      name?: null | string;
                      postCode?: null | string;
                  };
                  name?: null | string;
                  postCode?: null | string;
                  remark?: null | string;
              };
              goodsOwner?: {
                  id?: number;
                  name?: null | string;
              };
              orderInfo?: {
                  advanced?: {
                      arrivalDate?: null | string;
                      backOrderInfo?: {
                          backOrderForOrderId?: number;
                      };
                      deliveryDateWithTime?: string;
                      invoiceNumber?: null | string;
                  };
                  allocatedNumberOfItems?: number;
                  consigneeOrderNumber?: null | string;
                  createdDate?: string;
                  customerPrice?: null | number;
                  customsInfo?: {
                      customsValueCurrencyCode?: null | string;
                  };
                  deliveryDate?: string;
                  deliveryInstruction?: null | string;
                  emailNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  freeText1?: null | string;
                  freeText2?: null | string;
                  freeText3?: null | string;
                  goodsOwnerOrderId?: null | string;
                  marketPlace?: {
                      marketPlace?: null | string;
                      marketPlaceOrderNumber?: null | string;
                  };
                  orderId?: number;
                  orderNumber?: null | string;
                  orderRemark?: null | string;
                  orderStatus?: {
                      number?: number;
                      text?: null | string;
                  };
                  orderType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  orderedNumberOfItems?: number;
                  pickedNumberOfItems?: number;
                  pickingPriority?: null | number;
                  preparedTransportDocumentId?: null | string;
                  productionCode?: null | string;
                  referenceNumber?: null | string;
                  returnWayBill?: null | string;
                  salesCode?: null | string;
                  servicePointCode?: null | string;
                  shippedTime?: null | string;
                  smsNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  telephoneNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  termsOfDeliveryType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
                  warehouseInstruction?: null | string;
                  wayBill?: null | string;
                  wayOfDelivery?: {
                      code?: null | string;
                      name?: null | string;
                  };
              };
              orderLines?: null | {
                  allocatedNumberOfItems?: number;
                  article?: {
                      articleKind?: null | string;
                      articleName?: null | string;
                      articleNumber?: null | string;
                      articleSystemId?: number;
                      productCode?: null | string;
                  };
                  batchNumber?: null | string;
                  comment?: null | string;
                  customerArticleNumber?: null | string;
                  externalId?: null | string;
                  freeValues?: {
                      freeText1?: null | string;
                  };
                  id?: number;
                  lineTotalCustomsValue?: null | number;
                  lineType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  orderedNumberOfItems?: number;
                  packedNumberOfItems?: number;
                  pickedArticleItems?: null | {
                      articleItemId?: number;
                      articleItemStatus?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      batchNumber?: null | string;
                      caseNumber?: null | string;
                      comment?: null | string;
                      container?: null | string;
                      expiryDate?: null | string;
                      freeText1?: null | string;
                      handling?: {
                          packedByUserId?: null | number;
                          pickedByUserId?: null | number;
                      };
                      inDate?: string;
                      isPicked?: boolean;
                      isReturned?: boolean;
                      location?: null | string;
                      locationTypeCode?: null | string;
                      numberOfItems?: number;
                      packedTime?: null | string;
                      parcel?: {
                          advanced?: {
                              parcelSerialNumber?: null | string;
                          };
                          id?: number;
                          parcelNumber?: null | string;
                          parcelType?: {
                              code?: null | string;
                          };
                          parentParcel?: {
                              advanced?: {
                                  parcelSerialNumber?: null | string;
                              };
                              id?: number;
                              parcelNumber?: null | string;
                              parcelType?: {
                                  code?: null | string;
                              };
                          };
                      };
                      pickedTime?: null | string;
                      returnCause?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      returnDate?: null | string;
                      serial?: null | string;
                      volume?: null | number;
                      weight?: null | number;
                      zoneName?: null | string;
                  }[];
                  pickedNumberOfItems?: number;
                  prices?: {
                      currencyCode?: null | string;
                      customerLinePrice?: null | number;
                      discountPercentage?: null | number;
                      linePrice?: null | number;
                  };
                  reportedNumberOfItems?: null | number;
                  reportedReturnedNumberOfItems?: null | number;
                  returnedNumberOfItems?: number;
                  rowNumber?: null | string;
                  serialNumber?: null | string;
                  shouldBePicked?: boolean;
                  subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
              }[];
              parcels?: null | {
                  advanced?: {
                      parcelSerialNumber?: null | string;
                  };
                  id?: number;
                  isReturnParcel?: boolean;
                  parcelNumber?: null | string;
                  tracking?: {
                      trackingUrl?: null | string;
                  };
              }[];
              returnTransporter?: {
                  code?: null | string;
                  name?: null | string;
                  serviceCode?: null | string;
                  serviceComment?: null | string;
                  transporterContract?: {
                      comment?: null | string;
                  };
                  transporterName?: null | string;
              };
              shipmentInfo?: {
                  shipmentId?: number;
              };
              tracking?: null | {
                  created?: string;
                  trackingUrl?: null | string;
                  waybill?: null | string;
              }[];
              transporter?: {
                  code?: null | string;
                  name?: null | string;
                  serviceCode?: null | string;
                  serviceComment?: null | string;
                  transporterContract?: {
                      comment?: null | string;
                  };
                  transporterName?: null | string;
              };
          }
          • Optional classes?: null | ({
                code?: null | string;
                name?: null | string;
            } & Record<string, never>)[]
          • Optional consignee?: {
                address1?: null | string;
                address2?: null | string;
                address3?: null | string;
                advanced?: {
                    emailNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    smsNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    telephoneNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                };
                city?: null | string;
                countryCode?: null | string;
                countryStateCode?: null | string;
                customerNumber?: null | string;
                doorCode?: null | string;
                id?: number;
                invoiceAddress?: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    advanced?: {
                        emailNotification?: {
                            value?: null | string;
                        };
                        smsNotification?: {
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            value?: null | string;
                        };
                    };
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    name?: null | string;
                    postCode?: null | string;
                };
                name?: null | string;
                postCode?: null | string;
                remark?: null | string;
            }
            • Optional address1?: null | string
            • Optional address2?: null | string
            • Optional address3?: null | string
            • Optional advanced?: {
                  emailNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  smsNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  telephoneNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
              }
              • Optional emailNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                }
                • Optional toBeNotified?: boolean
                • Optional value?: null | string
              • Optional smsNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                }
                • Optional toBeNotified?: boolean
                • Optional value?: null | string
              • Optional telephoneNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                }
                • Optional toBeNotified?: boolean
                • Optional value?: null | string
            • Optional city?: null | string
            • Optional countryCode?: null | string
            • Optional countryStateCode?: null | string
            • Optional customerNumber?: null | string
            • Optional doorCode?: null | string
            • Optional id?: number

              Format: int32

            • Optional invoiceAddress?: {
                  address1?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  advanced?: {
                      emailNotification?: {
                          value?: null | string;
                      };
                      smsNotification?: {
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          value?: null | string;
                      };
                  };
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  name?: null | string;
                  postCode?: null | string;
              }
              • Optional address1?: null | string
              • Optional address2?: null | string
              • Optional address3?: null | string
              • Optional advanced?: {
                    emailNotification?: {
                        value?: null | string;
                    };
                    smsNotification?: {
                        value?: null | string;
                    };
                    telephoneNotification?: {
                        value?: null | string;
                    };
                }
                • Optional emailNotification?: {
                      value?: null | string;
                  }
                  • Optional value?: null | string
                • Optional smsNotification?: {
                      value?: null | string;
                  }
                  • Optional value?: null | string
                • Optional telephoneNotification?: {
                      value?: null | string;
                  }
                  • Optional value?: null | string
              • Optional city?: null | string
              • Optional countryCode?: null | string
              • Optional countryStateCode?: null | string
              • Optional name?: null | string
              • Optional postCode?: null | string
            • Optional name?: null | string
            • Optional postCode?: null | string
            • Optional remark?: null | string
          • Optional goodsOwner?: {
                id?: number;
                name?: null | string;
            }
            • Optional id?: number

              Format: int32

            • Optional name?: null | string
          • Optional orderInfo?: {
                advanced?: {
                    arrivalDate?: null | string;
                    backOrderInfo?: {
                        backOrderForOrderId?: number;
                    };
                    deliveryDateWithTime?: string;
                    invoiceNumber?: null | string;
                };
                allocatedNumberOfItems?: number;
                consigneeOrderNumber?: null | string;
                createdDate?: string;
                customerPrice?: null | number;
                customsInfo?: {
                    customsValueCurrencyCode?: null | string;
                };
                deliveryDate?: string;
                deliveryInstruction?: null | string;
                emailNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                freeText1?: null | string;
                freeText2?: null | string;
                freeText3?: null | string;
                goodsOwnerOrderId?: null | string;
                marketPlace?: {
                    marketPlace?: null | string;
                    marketPlaceOrderNumber?: null | string;
                };
                orderId?: number;
                orderNumber?: null | string;
                orderRemark?: null | string;
                orderStatus?: {
                    number?: number;
                    text?: null | string;
                };
                orderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                orderedNumberOfItems?: number;
                pickedNumberOfItems?: number;
                pickingPriority?: null | number;
                preparedTransportDocumentId?: null | string;
                productionCode?: null | string;
                referenceNumber?: null | string;
                returnWayBill?: null | string;
                salesCode?: null | string;
                servicePointCode?: null | string;
                shippedTime?: null | string;
                smsNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                telephoneNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                termsOfDeliveryType?: {
                    code?: null | string;
                    name?: null | string;
                };
                warehouse?: {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                };
                warehouseInstruction?: null | string;
                wayBill?: null | string;
                wayOfDelivery?: {
                    code?: null | string;
                    name?: null | string;
                };
            }
            • Optional advanced?: {
                  arrivalDate?: null | string;
                  backOrderInfo?: {
                      backOrderForOrderId?: number;
                  };
                  deliveryDateWithTime?: string;
                  invoiceNumber?: null | string;
              }
              • Optional arrivalDate?: null | string

                Format: date-time

              • Optional backOrderInfo?: {
                    backOrderForOrderId?: number;
                }
                • Optional backOrderForOrderId?: number

                  Format: int32

              • Optional deliveryDateWithTime?: string

                Format: date-time

              • Optional invoiceNumber?: null | string
            • Optional allocatedNumberOfItems?: number

              Format: decimal

            • Optional consigneeOrderNumber?: null | string
            • Optional createdDate?: string

              Format: date-time

            • Optional customerPrice?: null | number

              Format: decimal

            • Optional customsInfo?: {
                  customsValueCurrencyCode?: null | string;
              }
              • Optional customsValueCurrencyCode?: null | string
            • Optional deliveryDate?: string

              Format: date-time

            • Optional deliveryInstruction?: null | string
            • Optional emailNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              }
              • Optional toBeNotified?: boolean
              • Optional value?: null | string
            • Optional freeText1?: null | string
            • Optional freeText2?: null | string
            • Optional freeText3?: null | string
            • Optional goodsOwnerOrderId?: null | string
            • Optional marketPlace?: {
                  marketPlace?: null | string;
                  marketPlaceOrderNumber?: null | string;
              }
              • Optional marketPlace?: null | string
              • Optional marketPlaceOrderNumber?: null | string
            • Optional orderId?: number

              Format: int32

            • Optional orderNumber?: null | string
            • Optional orderRemark?: null | string
            • Optional orderStatus?: {
                  number?: number;
                  text?: null | string;
              }
              • Optional number?: number

                Format: int32

              • Optional text?: null | string
            • Optional orderType?: {
                  code?: null | string;
                  name?: null | string;
              }
              • Optional code?: null | string
              • Optional name?: null | string
            • Optional orderedNumberOfItems?: number

              Format: decimal

            • Optional pickedNumberOfItems?: number

              Format: decimal

            • Optional pickingPriority?: null | number

              Format: int32

            • Optional preparedTransportDocumentId?: null | string
            • Optional productionCode?: null | string
            • Optional referenceNumber?: null | string
            • Optional returnWayBill?: null | string
            • Optional salesCode?: null | string
            • Optional servicePointCode?: null | string
            • Optional shippedTime?: null | string

              Format: date-time

            • Optional smsNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              }
              • Optional toBeNotified?: boolean
              • Optional value?: null | string
            • Optional telephoneNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              }
              • Optional toBeNotified?: boolean
              • Optional value?: null | string
            • Optional termsOfDeliveryType?: {
                  code?: null | string;
                  name?: null | string;
              }
              • Optional code?: null | string
              • Optional name?: null | string
            • Optional warehouse?: {
                  code?: null | string;
                  id?: number;
                  name?: null | string;
              }
              • Optional code?: null | string
              • Optional id?: number

                Format: int32

              • Optional name?: null | string
            • Optional warehouseInstruction?: null | string
            • Optional wayBill?: null | string
            • Optional wayOfDelivery?: {
                  code?: null | string;
                  name?: null | string;
              }
              • Optional code?: null | string
              • Optional name?: null | string
          • Optional orderLines?: null | {
                allocatedNumberOfItems?: number;
                article?: {
                    articleKind?: null | string;
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    productCode?: null | string;
                };
                batchNumber?: null | string;
                comment?: null | string;
                customerArticleNumber?: null | string;
                externalId?: null | string;
                freeValues?: {
                    freeText1?: null | string;
                };
                id?: number;
                lineTotalCustomsValue?: null | number;
                lineType?: {
                    code?: null | string;
                    name?: null | string;
                };
                orderedNumberOfItems?: number;
                packedNumberOfItems?: number;
                pickedArticleItems?: null | {
                    articleItemId?: number;
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    batchNumber?: null | string;
                    caseNumber?: null | string;
                    comment?: null | string;
                    container?: null | string;
                    expiryDate?: null | string;
                    freeText1?: null | string;
                    handling?: {
                        packedByUserId?: null | number;
                        pickedByUserId?: null | number;
                    };
                    inDate?: string;
                    isPicked?: boolean;
                    isReturned?: boolean;
                    location?: null | string;
                    locationTypeCode?: null | string;
                    numberOfItems?: number;
                    packedTime?: null | string;
                    parcel?: {
                        advanced?: {
                            parcelSerialNumber?: null | string;
                        };
                        id?: number;
                        parcelNumber?: null | string;
                        parcelType?: {
                            code?: null | string;
                        };
                        parentParcel?: {
                            advanced?: {
                                parcelSerialNumber?: null | string;
                            };
                            id?: number;
                            parcelNumber?: null | string;
                            parcelType?: {
                                code?: null | string;
                            };
                        };
                    };
                    pickedTime?: null | string;
                    returnCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    returnDate?: null | string;
                    serial?: null | string;
                    volume?: null | number;
                    weight?: null | number;
                    zoneName?: null | string;
                }[];
                pickedNumberOfItems?: number;
                prices?: {
                    currencyCode?: null | string;
                    customerLinePrice?: null | number;
                    discountPercentage?: null | number;
                    linePrice?: null | number;
                };
                reportedNumberOfItems?: null | number;
                reportedReturnedNumberOfItems?: null | number;
                returnedNumberOfItems?: number;
                rowNumber?: null | string;
                serialNumber?: null | string;
                shouldBePicked?: boolean;
                subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
            }[]
          • Optional parcels?: null | {
                advanced?: {
                    parcelSerialNumber?: null | string;
                };
                id?: number;
                isReturnParcel?: boolean;
                parcelNumber?: null | string;
                tracking?: {
                    trackingUrl?: null | string;
                };
            }[]
          • Optional returnTransporter?: {
                code?: null | string;
                name?: null | string;
                serviceCode?: null | string;
                serviceComment?: null | string;
                transporterContract?: {
                    comment?: null | string;
                };
                transporterName?: null | string;
            }
            • Optional code?: null | string
            • Optional name?: null | string
            • Optional serviceCode?: null | string
            • Optional serviceComment?: null | string
            • Optional transporterContract?: {
                  comment?: null | string;
              }
              • Optional comment?: null | string
            • Optional transporterName?: null | string
          • Optional shipmentInfo?: {
                shipmentId?: number;
            }
            • Optional shipmentId?: number

              Format: int32

          • Optional tracking?: null | {
                created?: string;
                trackingUrl?: null | string;
                waybill?: null | string;
            }[]
          • Optional transporter?: {
                code?: null | string;
                name?: null | string;
                serviceCode?: null | string;
                serviceComment?: null | string;
                transporterContract?: {
                    comment?: null | string;
                };
                transporterName?: null | string;
            }
            • Optional code?: null | string
            • Optional name?: null | string
            • Optional serviceCode?: null | string
            • Optional serviceComment?: null | string
            • Optional transporterContract?: {
                  comment?: null | string;
              }
              • Optional comment?: null | string
            • Optional transporterName?: null | string
Orders_GetAll: {
    parameters: {
        query: {
            articleNumbers?: null | string[];
            backOrderForOrderId?: null | number;
            goodsOwnerId: number;
            lastReturnedFrom?: null | string;
            marketPlace?: null | string;
            maxOrdersToGet?: null | number;
            onlyIfTransportPrinted?: null | boolean;
            onlyOrdersWithOrderLinesToReport?: null | boolean;
            onlyOrdersWithOrderLinesToReportReturned?: null | boolean;
            orderCreatedTimeFrom?: null | string;
            orderCreatedTimeTo?: null | string;
            orderIdFrom?: null | number;
            orderNumber?: null | string;
            orderNumbers?: null | string[];
            orderStatusChangedTimeFrom?: null | string;
            orderStatusFrom?: null | number;
            orderStatusTo?: null | number;
            orderUpdatedTimeFrom?: null | string;
            parcelNumber?: null | string;
            pickable?: null | string;
            serial?: null | string;
            shipmentId?: null | number;
            shippedTimeFrom?: null | string;
            shippedTimeTo?: null | string;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    classes?: null | ({
                        code?: null | string;
                        name?: null | string;
                    } & Record<string, never>)[];
                    consignee?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                            smsNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        customerNumber?: null | string;
                        doorCode?: null | string;
                        id?: number;
                        invoiceAddress?: {
                            address1?: null | string;
                            address2?: null | string;
                            address3?: null | string;
                            advanced?: {
                                emailNotification?: {
                                    value?: null | string;
                                };
                                smsNotification?: {
                                    value?: null | string;
                                };
                                telephoneNotification?: {
                                    value?: null | string;
                                };
                            };
                            city?: null | string;
                            countryCode?: null | string;
                            countryStateCode?: null | string;
                            name?: null | string;
                            postCode?: null | string;
                        };
                        name?: null | string;
                        postCode?: null | string;
                        remark?: null | string;
                    };
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    orderInfo?: {
                        advanced?: {
                            arrivalDate?: null | string;
                            backOrderInfo?: {
                                backOrderForOrderId?: number;
                            };
                            deliveryDateWithTime?: string;
                            invoiceNumber?: null | string;
                        };
                        allocatedNumberOfItems?: number;
                        consigneeOrderNumber?: null | string;
                        createdDate?: string;
                        customerPrice?: null | number;
                        customsInfo?: {
                            customsValueCurrencyCode?: null | string;
                        };
                        deliveryDate?: string;
                        deliveryInstruction?: null | string;
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        freeText1?: null | string;
                        freeText2?: null | string;
                        freeText3?: null | string;
                        goodsOwnerOrderId?: null | string;
                        marketPlace?: {
                            marketPlace?: null | string;
                            marketPlaceOrderNumber?: null | string;
                        };
                        orderId?: number;
                        orderNumber?: null | string;
                        orderRemark?: null | string;
                        orderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        orderType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        orderedNumberOfItems?: number;
                        pickedNumberOfItems?: number;
                        pickingPriority?: null | number;
                        preparedTransportDocumentId?: null | string;
                        productionCode?: null | string;
                        referenceNumber?: null | string;
                        returnWayBill?: null | string;
                        salesCode?: null | string;
                        servicePointCode?: null | string;
                        shippedTime?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        termsOfDeliveryType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                        warehouseInstruction?: null | string;
                        wayBill?: null | string;
                        wayOfDelivery?: {
                            code?: null | string;
                            name?: null | string;
                        };
                    };
                    orderLines?: null | {
                        allocatedNumberOfItems?: number;
                        article?: {
                            articleKind?: null | string;
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                            productCode?: null | string;
                        };
                        batchNumber?: null | string;
                        comment?: null | string;
                        customerArticleNumber?: null | string;
                        externalId?: null | string;
                        freeValues?: {
                            freeText1?: null | string;
                        };
                        id?: number;
                        lineTotalCustomsValue?: null | number;
                        lineType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        orderedNumberOfItems?: number;
                        packedNumberOfItems?: number;
                        pickedArticleItems?: null | {
                            articleItemId?: number;
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batchNumber?: null | string;
                            caseNumber?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            freeText1?: null | string;
                            handling?: {
                                packedByUserId?: null | number;
                                pickedByUserId?: null | number;
                            };
                            inDate?: string;
                            isPicked?: boolean;
                            isReturned?: boolean;
                            location?: null | string;
                            locationTypeCode?: null | string;
                            numberOfItems?: number;
                            packedTime?: null | string;
                            parcel?: {
                                advanced?: {
                                    parcelSerialNumber?: null | string;
                                };
                                id?: number;
                                parcelNumber?: null | string;
                                parcelType?: {
                                    code?: null | string;
                                };
                                parentParcel?: {
                                    advanced?: {
                                        parcelSerialNumber?: null | string;
                                    };
                                    id?: number;
                                    parcelNumber?: null | string;
                                    parcelType?: {
                                        code?: null | string;
                                    };
                                };
                            };
                            pickedTime?: null | string;
                            returnCause?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            returnDate?: null | string;
                            serial?: null | string;
                            volume?: null | number;
                            weight?: null | number;
                            zoneName?: null | string;
                        }[];
                        pickedNumberOfItems?: number;
                        prices?: {
                            currencyCode?: null | string;
                            customerLinePrice?: null | number;
                            discountPercentage?: null | number;
                            linePrice?: null | number;
                        };
                        reportedNumberOfItems?: null | number;
                        reportedReturnedNumberOfItems?: null | number;
                        returnedNumberOfItems?: number;
                        rowNumber?: null | string;
                        serialNumber?: null | string;
                        shouldBePicked?: boolean;
                        subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
                    }[];
                    parcels?: null | {
                        advanced?: {
                            parcelSerialNumber?: null | string;
                        };
                        id?: number;
                        isReturnParcel?: boolean;
                        parcelNumber?: null | string;
                        tracking?: {
                            trackingUrl?: null | string;
                        };
                    }[];
                    returnTransporter?: {
                        code?: null | string;
                        name?: null | string;
                        serviceCode?: null | string;
                        serviceComment?: null | string;
                        transporterContract?: {
                            comment?: null | string;
                        };
                        transporterName?: null | string;
                    };
                    shipmentInfo?: {
                        shipmentId?: number;
                    };
                    tracking?: null | {
                        created?: string;
                        trackingUrl?: null | string;
                        waybill?: null | string;
                    }[];
                    transporter?: {
                        code?: null | string;
                        name?: null | string;
                        serviceCode?: null | string;
                        serviceComment?: null | string;
                        transporterContract?: {
                            comment?: null | string;
                        };
                        transporterName?: null | string;
                    };
                }[];
            };
        };
    };
}

Get all orders which match the specified search criteria.

Type declaration

  • parameters: {
        query: {
            articleNumbers?: null | string[];
            backOrderForOrderId?: null | number;
            goodsOwnerId: number;
            lastReturnedFrom?: null | string;
            marketPlace?: null | string;
            maxOrdersToGet?: null | number;
            onlyIfTransportPrinted?: null | boolean;
            onlyOrdersWithOrderLinesToReport?: null | boolean;
            onlyOrdersWithOrderLinesToReportReturned?: null | boolean;
            orderCreatedTimeFrom?: null | string;
            orderCreatedTimeTo?: null | string;
            orderIdFrom?: null | number;
            orderNumber?: null | string;
            orderNumbers?: null | string[];
            orderStatusChangedTimeFrom?: null | string;
            orderStatusFrom?: null | number;
            orderStatusTo?: null | number;
            orderUpdatedTimeFrom?: null | string;
            parcelNumber?: null | string;
            pickable?: null | string;
            serial?: null | string;
            shipmentId?: null | number;
            shippedTimeFrom?: null | string;
            shippedTimeTo?: null | string;
        };
    }
    • query: {
          articleNumbers?: null | string[];
          backOrderForOrderId?: null | number;
          goodsOwnerId: number;
          lastReturnedFrom?: null | string;
          marketPlace?: null | string;
          maxOrdersToGet?: null | number;
          onlyIfTransportPrinted?: null | boolean;
          onlyOrdersWithOrderLinesToReport?: null | boolean;
          onlyOrdersWithOrderLinesToReportReturned?: null | boolean;
          orderCreatedTimeFrom?: null | string;
          orderCreatedTimeTo?: null | string;
          orderIdFrom?: null | number;
          orderNumber?: null | string;
          orderNumbers?: null | string[];
          orderStatusChangedTimeFrom?: null | string;
          orderStatusFrom?: null | number;
          orderStatusTo?: null | number;
          orderUpdatedTimeFrom?: null | string;
          parcelNumber?: null | string;
          pickable?: null | string;
          serial?: null | string;
          shipmentId?: null | number;
          shippedTimeFrom?: null | string;
          shippedTimeTo?: null | string;
      }
      • Optional articleNumbers?: null | string[]

        Description

        Filter for orders which contains at least one of these article numbers.

      • Optional backOrderForOrderId?: null | number

        Description

        Only return orders which are back orders for the order with this order ID.

      • goodsOwnerId: number

        Description

        Goods owner ID.

      • Optional lastReturnedFrom?: null | string

        Description

        Only return orders which have been returned on since this time.

      • Optional marketPlace?: null | string
      • Optional maxOrdersToGet?: null | number

        Description

        The maximum number of orders to return.

      • Optional onlyIfTransportPrinted?: null | boolean

        Description

        Only return orders where the transport documents have been printed.

      • Optional onlyOrdersWithOrderLinesToReport?: null | boolean

        Description

        Only return orders where there are order lines with ReportedNumberOfItems < PickedNumberOfItems.

      • Optional onlyOrdersWithOrderLinesToReportReturned?: null | boolean

        Description

        Only return orders where there are order lines where ReportedReturnedNumberOfItems is less than the actual number of returned items.

      • Optional orderCreatedTimeFrom?: null | string

        Description

        Only return orders which have been created after this time.

      • Optional orderCreatedTimeTo?: null | string

        Description

        Only return orders which have been created before this time.

      • Optional orderIdFrom?: null | number

        Description

        Only return orders whose order ID is greater than or equal this.

      • Optional orderNumber?: null | string

        Description

        Order number.

      • Optional orderNumbers?: null | string[]
      • Optional orderStatusChangedTimeFrom?: null | string

        Description

        Only return orders whose status has changed after this time.

      • Optional orderStatusFrom?: null | number

        Description

        Filter for orders whose status is greater than or equal to this.

      • Optional orderStatusTo?: null | number

        Description

        Filter for orders whose status is lower than or equal to this.

      • Optional orderUpdatedTimeFrom?: null | string

        Description

        Only return orders which have been updated after this time. Note that this value must be at most 2 days old.

      • Optional parcelNumber?: null | string

        Description

        Filter for orders which contains a pallet/package with the specified parcel number.

      • Optional pickable?: null | string

        Description

        Either 'All' or 'NotPickable'. If it is 'NotPickable', only return orders which are not pickable.

      • Optional serial?: null | string

        Description

        Filter for orders which contains an item with the specified serial number.

      • Optional shipmentId?: null | number

        Description

        Only return orders belonging to this shipment.

      • Optional shippedTimeFrom?: null | string

        Description

        Filter for orders which were marked as 'shipped' after this time.

      • Optional shippedTimeTo?: null | string

        Description

        Filter for orders which were marked as 'shipped' before this time.

  • responses: {
        200: {
            content: {
                application/json: {
                    classes?: null | ({
                        code?: null | string;
                        name?: null | string;
                    } & Record<string, never>)[];
                    consignee?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                            smsNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                toBeNotified?: boolean;
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        customerNumber?: null | string;
                        doorCode?: null | string;
                        id?: number;
                        invoiceAddress?: {
                            address1?: null | string;
                            address2?: null | string;
                            address3?: null | string;
                            advanced?: {
                                emailNotification?: {
                                    value?: null | string;
                                };
                                smsNotification?: {
                                    value?: null | string;
                                };
                                telephoneNotification?: {
                                    value?: null | string;
                                };
                            };
                            city?: null | string;
                            countryCode?: null | string;
                            countryStateCode?: null | string;
                            name?: null | string;
                            postCode?: null | string;
                        };
                        name?: null | string;
                        postCode?: null | string;
                        remark?: null | string;
                    };
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    orderInfo?: {
                        advanced?: {
                            arrivalDate?: null | string;
                            backOrderInfo?: {
                                backOrderForOrderId?: number;
                            };
                            deliveryDateWithTime?: string;
                            invoiceNumber?: null | string;
                        };
                        allocatedNumberOfItems?: number;
                        consigneeOrderNumber?: null | string;
                        createdDate?: string;
                        customerPrice?: null | number;
                        customsInfo?: {
                            customsValueCurrencyCode?: null | string;
                        };
                        deliveryDate?: string;
                        deliveryInstruction?: null | string;
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        freeText1?: null | string;
                        freeText2?: null | string;
                        freeText3?: null | string;
                        goodsOwnerOrderId?: null | string;
                        marketPlace?: {
                            marketPlace?: null | string;
                            marketPlaceOrderNumber?: null | string;
                        };
                        orderId?: number;
                        orderNumber?: null | string;
                        orderRemark?: null | string;
                        orderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        orderType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        orderedNumberOfItems?: number;
                        pickedNumberOfItems?: number;
                        pickingPriority?: null | number;
                        preparedTransportDocumentId?: null | string;
                        productionCode?: null | string;
                        referenceNumber?: null | string;
                        returnWayBill?: null | string;
                        salesCode?: null | string;
                        servicePointCode?: null | string;
                        shippedTime?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        termsOfDeliveryType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                        warehouseInstruction?: null | string;
                        wayBill?: null | string;
                        wayOfDelivery?: {
                            code?: null | string;
                            name?: null | string;
                        };
                    };
                    orderLines?: null | {
                        allocatedNumberOfItems?: number;
                        article?: {
                            articleKind?: null | string;
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                            productCode?: null | string;
                        };
                        batchNumber?: null | string;
                        comment?: null | string;
                        customerArticleNumber?: null | string;
                        externalId?: null | string;
                        freeValues?: {
                            freeText1?: null | string;
                        };
                        id?: number;
                        lineTotalCustomsValue?: null | number;
                        lineType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        orderedNumberOfItems?: number;
                        packedNumberOfItems?: number;
                        pickedArticleItems?: null | {
                            articleItemId?: number;
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batchNumber?: null | string;
                            caseNumber?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            freeText1?: null | string;
                            handling?: {
                                packedByUserId?: null | number;
                                pickedByUserId?: null | number;
                            };
                            inDate?: string;
                            isPicked?: boolean;
                            isReturned?: boolean;
                            location?: null | string;
                            locationTypeCode?: null | string;
                            numberOfItems?: number;
                            packedTime?: null | string;
                            parcel?: {
                                advanced?: {
                                    parcelSerialNumber?: null | string;
                                };
                                id?: number;
                                parcelNumber?: null | string;
                                parcelType?: {
                                    code?: null | string;
                                };
                                parentParcel?: {
                                    advanced?: {
                                        parcelSerialNumber?: null | string;
                                    };
                                    id?: number;
                                    parcelNumber?: null | string;
                                    parcelType?: {
                                        code?: null | string;
                                    };
                                };
                            };
                            pickedTime?: null | string;
                            returnCause?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            returnDate?: null | string;
                            serial?: null | string;
                            volume?: null | number;
                            weight?: null | number;
                            zoneName?: null | string;
                        }[];
                        pickedNumberOfItems?: number;
                        prices?: {
                            currencyCode?: null | string;
                            customerLinePrice?: null | number;
                            discountPercentage?: null | number;
                            linePrice?: null | number;
                        };
                        reportedNumberOfItems?: null | number;
                        reportedReturnedNumberOfItems?: null | number;
                        returnedNumberOfItems?: number;
                        rowNumber?: null | string;
                        serialNumber?: null | string;
                        shouldBePicked?: boolean;
                        subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
                    }[];
                    parcels?: null | {
                        advanced?: {
                            parcelSerialNumber?: null | string;
                        };
                        id?: number;
                        isReturnParcel?: boolean;
                        parcelNumber?: null | string;
                        tracking?: {
                            trackingUrl?: null | string;
                        };
                    }[];
                    returnTransporter?: {
                        code?: null | string;
                        name?: null | string;
                        serviceCode?: null | string;
                        serviceComment?: null | string;
                        transporterContract?: {
                            comment?: null | string;
                        };
                        transporterName?: null | string;
                    };
                    shipmentInfo?: {
                        shipmentId?: number;
                    };
                    tracking?: null | {
                        created?: string;
                        trackingUrl?: null | string;
                        waybill?: null | string;
                    }[];
                    transporter?: {
                        code?: null | string;
                        name?: null | string;
                        serviceCode?: null | string;
                        serviceComment?: null | string;
                        transporterContract?: {
                            comment?: null | string;
                        };
                        transporterName?: null | string;
                    };
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  classes?: null | ({
                      code?: null | string;
                      name?: null | string;
                  } & Record<string, never>)[];
                  consignee?: {
                      address1?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      advanced?: {
                          emailNotification?: {
                              toBeNotified?: boolean;
                              value?: null | string;
                          };
                          smsNotification?: {
                              toBeNotified?: boolean;
                              value?: null | string;
                          };
                          telephoneNotification?: {
                              toBeNotified?: boolean;
                              value?: null | string;
                          };
                      };
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      customerNumber?: null | string;
                      doorCode?: null | string;
                      id?: number;
                      invoiceAddress?: {
                          address1?: null | string;
                          address2?: null | string;
                          address3?: null | string;
                          advanced?: {
                              emailNotification?: {
                                  value?: null | string;
                              };
                              smsNotification?: {
                                  value?: null | string;
                              };
                              telephoneNotification?: {
                                  value?: null | string;
                              };
                          };
                          city?: null | string;
                          countryCode?: null | string;
                          countryStateCode?: null | string;
                          name?: null | string;
                          postCode?: null | string;
                      };
                      name?: null | string;
                      postCode?: null | string;
                      remark?: null | string;
                  };
                  goodsOwner?: {
                      id?: number;
                      name?: null | string;
                  };
                  orderInfo?: {
                      advanced?: {
                          arrivalDate?: null | string;
                          backOrderInfo?: {
                              backOrderForOrderId?: number;
                          };
                          deliveryDateWithTime?: string;
                          invoiceNumber?: null | string;
                      };
                      allocatedNumberOfItems?: number;
                      consigneeOrderNumber?: null | string;
                      createdDate?: string;
                      customerPrice?: null | number;
                      customsInfo?: {
                          customsValueCurrencyCode?: null | string;
                      };
                      deliveryDate?: string;
                      deliveryInstruction?: null | string;
                      emailNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      freeText1?: null | string;
                      freeText2?: null | string;
                      freeText3?: null | string;
                      goodsOwnerOrderId?: null | string;
                      marketPlace?: {
                          marketPlace?: null | string;
                          marketPlaceOrderNumber?: null | string;
                      };
                      orderId?: number;
                      orderNumber?: null | string;
                      orderRemark?: null | string;
                      orderStatus?: {
                          number?: number;
                          text?: null | string;
                      };
                      orderType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      orderedNumberOfItems?: number;
                      pickedNumberOfItems?: number;
                      pickingPriority?: null | number;
                      preparedTransportDocumentId?: null | string;
                      productionCode?: null | string;
                      referenceNumber?: null | string;
                      returnWayBill?: null | string;
                      salesCode?: null | string;
                      servicePointCode?: null | string;
                      shippedTime?: null | string;
                      smsNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      termsOfDeliveryType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      warehouse?: {
                          code?: null | string;
                          id?: number;
                          name?: null | string;
                      };
                      warehouseInstruction?: null | string;
                      wayBill?: null | string;
                      wayOfDelivery?: {
                          code?: null | string;
                          name?: null | string;
                      };
                  };
                  orderLines?: null | {
                      allocatedNumberOfItems?: number;
                      article?: {
                          articleKind?: null | string;
                          articleName?: null | string;
                          articleNumber?: null | string;
                          articleSystemId?: number;
                          productCode?: null | string;
                      };
                      batchNumber?: null | string;
                      comment?: null | string;
                      customerArticleNumber?: null | string;
                      externalId?: null | string;
                      freeValues?: {
                          freeText1?: null | string;
                      };
                      id?: number;
                      lineTotalCustomsValue?: null | number;
                      lineType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      orderedNumberOfItems?: number;
                      packedNumberOfItems?: number;
                      pickedArticleItems?: null | {
                          articleItemId?: number;
                          articleItemStatus?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          batchNumber?: null | string;
                          caseNumber?: null | string;
                          comment?: null | string;
                          container?: null | string;
                          expiryDate?: null | string;
                          freeText1?: null | string;
                          handling?: {
                              packedByUserId?: null | number;
                              pickedByUserId?: null | number;
                          };
                          inDate?: string;
                          isPicked?: boolean;
                          isReturned?: boolean;
                          location?: null | string;
                          locationTypeCode?: null | string;
                          numberOfItems?: number;
                          packedTime?: null | string;
                          parcel?: {
                              advanced?: {
                                  parcelSerialNumber?: null | string;
                              };
                              id?: number;
                              parcelNumber?: null | string;
                              parcelType?: {
                                  code?: null | string;
                              };
                              parentParcel?: {
                                  advanced?: {
                                      parcelSerialNumber?: null | string;
                                  };
                                  id?: number;
                                  parcelNumber?: null | string;
                                  parcelType?: {
                                      code?: null | string;
                                  };
                              };
                          };
                          pickedTime?: null | string;
                          returnCause?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          returnDate?: null | string;
                          serial?: null | string;
                          volume?: null | number;
                          weight?: null | number;
                          zoneName?: null | string;
                      }[];
                      pickedNumberOfItems?: number;
                      prices?: {
                          currencyCode?: null | string;
                          customerLinePrice?: null | number;
                          discountPercentage?: null | number;
                          linePrice?: null | number;
                      };
                      reportedNumberOfItems?: null | number;
                      reportedReturnedNumberOfItems?: null | number;
                      returnedNumberOfItems?: number;
                      rowNumber?: null | string;
                      serialNumber?: null | string;
                      shouldBePicked?: boolean;
                      subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
                  }[];
                  parcels?: null | {
                      advanced?: {
                          parcelSerialNumber?: null | string;
                      };
                      id?: number;
                      isReturnParcel?: boolean;
                      parcelNumber?: null | string;
                      tracking?: {
                          trackingUrl?: null | string;
                      };
                  }[];
                  returnTransporter?: {
                      code?: null | string;
                      name?: null | string;
                      serviceCode?: null | string;
                      serviceComment?: null | string;
                      transporterContract?: {
                          comment?: null | string;
                      };
                      transporterName?: null | string;
                  };
                  shipmentInfo?: {
                      shipmentId?: number;
                  };
                  tracking?: null | {
                      created?: string;
                      trackingUrl?: null | string;
                      waybill?: null | string;
                  }[];
                  transporter?: {
                      code?: null | string;
                      name?: null | string;
                      serviceCode?: null | string;
                      serviceComment?: null | string;
                      transporterContract?: {
                          comment?: null | string;
                      };
                      transporterName?: null | string;
                  };
              }[];
          };
      }
      • content: {
            application/json: {
                classes?: null | ({
                    code?: null | string;
                    name?: null | string;
                } & Record<string, never>)[];
                consignee?: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    advanced?: {
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                    };
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    customerNumber?: null | string;
                    doorCode?: null | string;
                    id?: number;
                    invoiceAddress?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                value?: null | string;
                            };
                            smsNotification?: {
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        name?: null | string;
                        postCode?: null | string;
                    };
                    name?: null | string;
                    postCode?: null | string;
                    remark?: null | string;
                };
                goodsOwner?: {
                    id?: number;
                    name?: null | string;
                };
                orderInfo?: {
                    advanced?: {
                        arrivalDate?: null | string;
                        backOrderInfo?: {
                            backOrderForOrderId?: number;
                        };
                        deliveryDateWithTime?: string;
                        invoiceNumber?: null | string;
                    };
                    allocatedNumberOfItems?: number;
                    consigneeOrderNumber?: null | string;
                    createdDate?: string;
                    customerPrice?: null | number;
                    customsInfo?: {
                        customsValueCurrencyCode?: null | string;
                    };
                    deliveryDate?: string;
                    deliveryInstruction?: null | string;
                    emailNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    freeText1?: null | string;
                    freeText2?: null | string;
                    freeText3?: null | string;
                    goodsOwnerOrderId?: null | string;
                    marketPlace?: {
                        marketPlace?: null | string;
                        marketPlaceOrderNumber?: null | string;
                    };
                    orderId?: number;
                    orderNumber?: null | string;
                    orderRemark?: null | string;
                    orderStatus?: {
                        number?: number;
                        text?: null | string;
                    };
                    orderType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    orderedNumberOfItems?: number;
                    pickedNumberOfItems?: number;
                    pickingPriority?: null | number;
                    preparedTransportDocumentId?: null | string;
                    productionCode?: null | string;
                    referenceNumber?: null | string;
                    returnWayBill?: null | string;
                    salesCode?: null | string;
                    servicePointCode?: null | string;
                    shippedTime?: null | string;
                    smsNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    telephoneNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    termsOfDeliveryType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                    warehouseInstruction?: null | string;
                    wayBill?: null | string;
                    wayOfDelivery?: {
                        code?: null | string;
                        name?: null | string;
                    };
                };
                orderLines?: null | {
                    allocatedNumberOfItems?: number;
                    article?: {
                        articleKind?: null | string;
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        productCode?: null | string;
                    };
                    batchNumber?: null | string;
                    comment?: null | string;
                    customerArticleNumber?: null | string;
                    externalId?: null | string;
                    freeValues?: {
                        freeText1?: null | string;
                    };
                    id?: number;
                    lineTotalCustomsValue?: null | number;
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    orderedNumberOfItems?: number;
                    packedNumberOfItems?: number;
                    pickedArticleItems?: null | {
                        articleItemId?: number;
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batchNumber?: null | string;
                        caseNumber?: null | string;
                        comment?: null | string;
                        container?: null | string;
                        expiryDate?: null | string;
                        freeText1?: null | string;
                        handling?: {
                            packedByUserId?: null | number;
                            pickedByUserId?: null | number;
                        };
                        inDate?: string;
                        isPicked?: boolean;
                        isReturned?: boolean;
                        location?: null | string;
                        locationTypeCode?: null | string;
                        numberOfItems?: number;
                        packedTime?: null | string;
                        parcel?: {
                            advanced?: {
                                parcelSerialNumber?: null | string;
                            };
                            id?: number;
                            parcelNumber?: null | string;
                            parcelType?: {
                                code?: null | string;
                            };
                            parentParcel?: {
                                advanced?: {
                                    parcelSerialNumber?: null | string;
                                };
                                id?: number;
                                parcelNumber?: null | string;
                                parcelType?: {
                                    code?: null | string;
                                };
                            };
                        };
                        pickedTime?: null | string;
                        returnCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        returnDate?: null | string;
                        serial?: null | string;
                        volume?: null | number;
                        weight?: null | number;
                        zoneName?: null | string;
                    }[];
                    pickedNumberOfItems?: number;
                    prices?: {
                        currencyCode?: null | string;
                        customerLinePrice?: null | number;
                        discountPercentage?: null | number;
                        linePrice?: null | number;
                    };
                    reportedNumberOfItems?: null | number;
                    reportedReturnedNumberOfItems?: null | number;
                    returnedNumberOfItems?: number;
                    rowNumber?: null | string;
                    serialNumber?: null | string;
                    shouldBePicked?: boolean;
                    subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
                }[];
                parcels?: null | {
                    advanced?: {
                        parcelSerialNumber?: null | string;
                    };
                    id?: number;
                    isReturnParcel?: boolean;
                    parcelNumber?: null | string;
                    tracking?: {
                        trackingUrl?: null | string;
                    };
                }[];
                returnTransporter?: {
                    code?: null | string;
                    name?: null | string;
                    serviceCode?: null | string;
                    serviceComment?: null | string;
                    transporterContract?: {
                        comment?: null | string;
                    };
                    transporterName?: null | string;
                };
                shipmentInfo?: {
                    shipmentId?: number;
                };
                tracking?: null | {
                    created?: string;
                    trackingUrl?: null | string;
                    waybill?: null | string;
                }[];
                transporter?: {
                    code?: null | string;
                    name?: null | string;
                    serviceCode?: null | string;
                    serviceComment?: null | string;
                    transporterContract?: {
                        comment?: null | string;
                    };
                    transporterName?: null | string;
                };
            }[];
        }
        • application/json: {
              classes?: null | ({
                  code?: null | string;
                  name?: null | string;
              } & Record<string, never>)[];
              consignee?: {
                  address1?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  advanced?: {
                      emailNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      smsNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                  };
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  customerNumber?: null | string;
                  doorCode?: null | string;
                  id?: number;
                  invoiceAddress?: {
                      address1?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      advanced?: {
                          emailNotification?: {
                              value?: null | string;
                          };
                          smsNotification?: {
                              value?: null | string;
                          };
                          telephoneNotification?: {
                              value?: null | string;
                          };
                      };
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      name?: null | string;
                      postCode?: null | string;
                  };
                  name?: null | string;
                  postCode?: null | string;
                  remark?: null | string;
              };
              goodsOwner?: {
                  id?: number;
                  name?: null | string;
              };
              orderInfo?: {
                  advanced?: {
                      arrivalDate?: null | string;
                      backOrderInfo?: {
                          backOrderForOrderId?: number;
                      };
                      deliveryDateWithTime?: string;
                      invoiceNumber?: null | string;
                  };
                  allocatedNumberOfItems?: number;
                  consigneeOrderNumber?: null | string;
                  createdDate?: string;
                  customerPrice?: null | number;
                  customsInfo?: {
                      customsValueCurrencyCode?: null | string;
                  };
                  deliveryDate?: string;
                  deliveryInstruction?: null | string;
                  emailNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  freeText1?: null | string;
                  freeText2?: null | string;
                  freeText3?: null | string;
                  goodsOwnerOrderId?: null | string;
                  marketPlace?: {
                      marketPlace?: null | string;
                      marketPlaceOrderNumber?: null | string;
                  };
                  orderId?: number;
                  orderNumber?: null | string;
                  orderRemark?: null | string;
                  orderStatus?: {
                      number?: number;
                      text?: null | string;
                  };
                  orderType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  orderedNumberOfItems?: number;
                  pickedNumberOfItems?: number;
                  pickingPriority?: null | number;
                  preparedTransportDocumentId?: null | string;
                  productionCode?: null | string;
                  referenceNumber?: null | string;
                  returnWayBill?: null | string;
                  salesCode?: null | string;
                  servicePointCode?: null | string;
                  shippedTime?: null | string;
                  smsNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  telephoneNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  termsOfDeliveryType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
                  warehouseInstruction?: null | string;
                  wayBill?: null | string;
                  wayOfDelivery?: {
                      code?: null | string;
                      name?: null | string;
                  };
              };
              orderLines?: null | {
                  allocatedNumberOfItems?: number;
                  article?: {
                      articleKind?: null | string;
                      articleName?: null | string;
                      articleNumber?: null | string;
                      articleSystemId?: number;
                      productCode?: null | string;
                  };
                  batchNumber?: null | string;
                  comment?: null | string;
                  customerArticleNumber?: null | string;
                  externalId?: null | string;
                  freeValues?: {
                      freeText1?: null | string;
                  };
                  id?: number;
                  lineTotalCustomsValue?: null | number;
                  lineType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  orderedNumberOfItems?: number;
                  packedNumberOfItems?: number;
                  pickedArticleItems?: null | {
                      articleItemId?: number;
                      articleItemStatus?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      batchNumber?: null | string;
                      caseNumber?: null | string;
                      comment?: null | string;
                      container?: null | string;
                      expiryDate?: null | string;
                      freeText1?: null | string;
                      handling?: {
                          packedByUserId?: null | number;
                          pickedByUserId?: null | number;
                      };
                      inDate?: string;
                      isPicked?: boolean;
                      isReturned?: boolean;
                      location?: null | string;
                      locationTypeCode?: null | string;
                      numberOfItems?: number;
                      packedTime?: null | string;
                      parcel?: {
                          advanced?: {
                              parcelSerialNumber?: null | string;
                          };
                          id?: number;
                          parcelNumber?: null | string;
                          parcelType?: {
                              code?: null | string;
                          };
                          parentParcel?: {
                              advanced?: {
                                  parcelSerialNumber?: null | string;
                              };
                              id?: number;
                              parcelNumber?: null | string;
                              parcelType?: {
                                  code?: null | string;
                              };
                          };
                      };
                      pickedTime?: null | string;
                      returnCause?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      returnDate?: null | string;
                      serial?: null | string;
                      volume?: null | number;
                      weight?: null | number;
                      zoneName?: null | string;
                  }[];
                  pickedNumberOfItems?: number;
                  prices?: {
                      currencyCode?: null | string;
                      customerLinePrice?: null | number;
                      discountPercentage?: null | number;
                      linePrice?: null | number;
                  };
                  reportedNumberOfItems?: null | number;
                  reportedReturnedNumberOfItems?: null | number;
                  returnedNumberOfItems?: number;
                  rowNumber?: null | string;
                  serialNumber?: null | string;
                  shouldBePicked?: boolean;
                  subOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...)[];
              }[];
              parcels?: null | {
                  advanced?: {
                      parcelSerialNumber?: null | string;
                  };
                  id?: number;
                  isReturnParcel?: boolean;
                  parcelNumber?: null | string;
                  tracking?: {
                      trackingUrl?: null | string;
                  };
              }[];
              returnTransporter?: {
                  code?: null | string;
                  name?: null | string;
                  serviceCode?: null | string;
                  serviceComment?: null | string;
                  transporterContract?: {
                      comment?: null | string;
                  };
                  transporterName?: null | string;
              };
              shipmentInfo?: {
                  shipmentId?: number;
              };
              tracking?: null | {
                  created?: string;
                  trackingUrl?: null | string;
                  waybill?: null | string;
              }[];
              transporter?: {
                  code?: null | string;
                  name?: null | string;
                  serviceCode?: null | string;
                  serviceComment?: null | string;
                  transporterContract?: {
                      comment?: null | string;
                  };
                  transporterName?: null | string;
              };
          }[]
Orders_GetFiles: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    articleSystemId?: null | number;
                    fileDataBase64?: null | string;
                    fileId?: number;
                    fileName?: null | string;
                    mimeType?: null | string;
                    orderId?: null | number;
                    purchaseOrderId?: null | number;
                }[];
            };
        };
    };
}

Get all files which are attached to a specific order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • responses: {
        200: {
            content: {
                application/json: null | {
                    articleSystemId?: null | number;
                    fileDataBase64?: null | string;
                    fileId?: number;
                    fileName?: null | string;
                    mimeType?: null | string;
                    orderId?: null | number;
                    purchaseOrderId?: null | number;
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  articleSystemId?: null | number;
                  fileDataBase64?: null | string;
                  fileId?: number;
                  fileName?: null | string;
                  mimeType?: null | string;
                  orderId?: null | number;
                  purchaseOrderId?: null | number;
              }[];
          };
      }
      • content: {
            application/json: null | {
                articleSystemId?: null | number;
                fileDataBase64?: null | string;
                fileId?: number;
                fileName?: null | string;
                mimeType?: null | string;
                orderId?: null | number;
                purchaseOrderId?: null | number;
            }[];
        }
        • application/json: null | {
              articleSystemId?: null | number;
              fileDataBase64?: null | string;
              fileId?: number;
              fileName?: null | string;
              mimeType?: null | string;
              orderId?: null | number;
              purchaseOrderId?: null | number;
          }[]
Orders_GetInvoiceCharges: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    actionDate?: null | string;
                    chargeId?: number;
                    comment?: null | string;
                    invoiceArticle?: {
                        account?: null | string;
                        code?: null | string;
                        invoiceArticleId?: number;
                        title?: null | string;
                    };
                    invoiceId?: number;
                    numberOfItems?: number;
                    price?: number;
                    profitCenter?: {
                        code?: null | string;
                        name?: null | string;
                    };
                }[];
            };
        };
    };
}

Get all invoice charges for an order. This function requires an additional permission for the API user, see Administration->Integration->API for goods owners.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • responses: {
        200: {
            content: {
                application/json: null | {
                    actionDate?: null | string;
                    chargeId?: number;
                    comment?: null | string;
                    invoiceArticle?: {
                        account?: null | string;
                        code?: null | string;
                        invoiceArticleId?: number;
                        title?: null | string;
                    };
                    invoiceId?: number;
                    numberOfItems?: number;
                    price?: number;
                    profitCenter?: {
                        code?: null | string;
                        name?: null | string;
                    };
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  actionDate?: null | string;
                  chargeId?: number;
                  comment?: null | string;
                  invoiceArticle?: {
                      account?: null | string;
                      code?: null | string;
                      invoiceArticleId?: number;
                      title?: null | string;
                  };
                  invoiceId?: number;
                  numberOfItems?: number;
                  price?: number;
                  profitCenter?: {
                      code?: null | string;
                      name?: null | string;
                  };
              }[];
          };
      }
      • content: {
            application/json: null | {
                actionDate?: null | string;
                chargeId?: number;
                comment?: null | string;
                invoiceArticle?: {
                    account?: null | string;
                    code?: null | string;
                    invoiceArticleId?: number;
                    title?: null | string;
                };
                invoiceId?: number;
                numberOfItems?: number;
                price?: number;
                profitCenter?: {
                    code?: null | string;
                    name?: null | string;
                };
            }[];
        }
        • application/json: null | {
              actionDate?: null | string;
              chargeId?: number;
              comment?: null | string;
              invoiceArticle?: {
                  account?: null | string;
                  code?: null | string;
                  invoiceArticleId?: number;
                  title?: null | string;
              };
              invoiceId?: number;
              numberOfItems?: number;
              price?: number;
              profitCenter?: {
                  code?: null | string;
                  name?: null | string;
              };
          }[]
Orders_GetOrderClasses: {
    parameters: {
        query: {
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    orderClasses?: null | {
                        code?: null | string;
                        comment?: null | string;
                        name?: null | string;
                    }[];
                };
            };
        };
    };
}

Get all order classes.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
        };
    }
    • query: {
          goodsOwnerId: number;
      }
      • goodsOwnerId: number
  • responses: {
        200: {
            content: {
                application/json: {
                    orderClasses?: null | {
                        code?: null | string;
                        comment?: null | string;
                        name?: null | string;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  orderClasses?: null | {
                      code?: null | string;
                      comment?: null | string;
                      name?: null | string;
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                orderClasses?: null | {
                    code?: null | string;
                    comment?: null | string;
                    name?: null | string;
                }[];
            };
        }
        • application/json: {
              orderClasses?: null | {
                  code?: null | string;
                  comment?: null | string;
                  name?: null | string;
              }[];
          }
          • Optional orderClasses?: null | {
                code?: null | string;
                comment?: null | string;
                name?: null | string;
            }[]
Orders_GetOrderStatuses: {
    responses: {
        200: {
            content: {
                application/json: {
                    orderStatuses?: null | {
                        number?: number;
                        text?: null | string;
                    }[];
                };
            };
        };
    };
}

Get all order statuses.

Type declaration

  • responses: {
        200: {
            content: {
                application/json: {
                    orderStatuses?: null | {
                        number?: number;
                        text?: null | string;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  orderStatuses?: null | {
                      number?: number;
                      text?: null | string;
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                orderStatuses?: null | {
                    number?: number;
                    text?: null | string;
                }[];
            };
        }
        • application/json: {
              orderStatuses?: null | {
                  number?: number;
                  text?: null | string;
              }[];
          }
          • Optional orderStatuses?: null | {
                number?: number;
                text?: null | string;
            }[]
Orders_GetOrderTypes: {
    parameters: {
        query: {
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    orderTypes?: null | ({
                        code?: null | string;
                        name?: null | string;
                    } & Record<string, never>)[];
                };
            };
        };
    };
}

Get all order types for a particular goods owner.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
        };
    }
    • query: {
          goodsOwnerId: number;
      }
      • goodsOwnerId: number
  • responses: {
        200: {
            content: {
                application/json: {
                    orderTypes?: null | ({
                        code?: null | string;
                        name?: null | string;
                    } & Record<string, never>)[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  orderTypes?: null | ({
                      code?: null | string;
                      name?: null | string;
                  } & Record<string, never>)[];
              };
          };
      }
      • content: {
            application/json: {
                orderTypes?: null | ({
                    code?: null | string;
                    name?: null | string;
                } & Record<string, never>)[];
            };
        }
        • application/json: {
              orderTypes?: null | ({
                  code?: null | string;
                  name?: null | string;
              } & Record<string, never>)[];
          }
          • Optional orderTypes?: null | ({
                code?: null | string;
                name?: null | string;
            } & Record<string, never>)[]
Orders_GetWayBillRows: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    approvedNumberOfPackages?: null | number;
                    category?: null | string;
                    comment?: null | string;
                    height?: null | number;
                    length?: null | number;
                    numberOfPackages?: number;
                    parcelType?: {
                        barCode?: null | string;
                        code?: null | string;
                        height?: null | number;
                        length?: null | number;
                        loadMeters?: null | number;
                        name?: null | string;
                        weight?: null | number;
                        width?: null | number;
                    };
                    volume?: null | number;
                    wayBillRowId?: number;
                    weight?: null | number;
                    width?: null | number;
                }[];
            };
        };
    };
}

Get all waybill rows for an order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • responses: {
        200: {
            content: {
                application/json: null | {
                    approvedNumberOfPackages?: null | number;
                    category?: null | string;
                    comment?: null | string;
                    height?: null | number;
                    length?: null | number;
                    numberOfPackages?: number;
                    parcelType?: {
                        barCode?: null | string;
                        code?: null | string;
                        height?: null | number;
                        length?: null | number;
                        loadMeters?: null | number;
                        name?: null | string;
                        weight?: null | number;
                        width?: null | number;
                    };
                    volume?: null | number;
                    wayBillRowId?: number;
                    weight?: null | number;
                    width?: null | number;
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  approvedNumberOfPackages?: null | number;
                  category?: null | string;
                  comment?: null | string;
                  height?: null | number;
                  length?: null | number;
                  numberOfPackages?: number;
                  parcelType?: {
                      barCode?: null | string;
                      code?: null | string;
                      height?: null | number;
                      length?: null | number;
                      loadMeters?: null | number;
                      name?: null | string;
                      weight?: null | number;
                      width?: null | number;
                  };
                  volume?: null | number;
                  wayBillRowId?: number;
                  weight?: null | number;
                  width?: null | number;
              }[];
          };
      }
      • content: {
            application/json: null | {
                approvedNumberOfPackages?: null | number;
                category?: null | string;
                comment?: null | string;
                height?: null | number;
                length?: null | number;
                numberOfPackages?: number;
                parcelType?: {
                    barCode?: null | string;
                    code?: null | string;
                    height?: null | number;
                    length?: null | number;
                    loadMeters?: null | number;
                    name?: null | string;
                    weight?: null | number;
                    width?: null | number;
                };
                volume?: null | number;
                wayBillRowId?: number;
                weight?: null | number;
                width?: null | number;
            }[];
        }
        • application/json: null | {
              approvedNumberOfPackages?: null | number;
              category?: null | string;
              comment?: null | string;
              height?: null | number;
              length?: null | number;
              numberOfPackages?: number;
              parcelType?: {
                  barCode?: null | string;
                  code?: null | string;
                  height?: null | number;
                  length?: null | number;
                  loadMeters?: null | number;
                  name?: null | string;
                  weight?: null | number;
                  width?: null | number;
              };
              volume?: null | number;
              wayBillRowId?: number;
              weight?: null | number;
              width?: null | number;
          }[]
Orders_GetWayOfDeliveryTypes: {
    parameters: {
        query: {
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    wayOfDeliveryTypes?: null | {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    }[];
                };
            };
        };
    };
}

Get all order way of delivery types.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
        };
    }
    • query: {
          goodsOwnerId: number;
      }
      • goodsOwnerId: number

        Description

        Goods owner ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    wayOfDeliveryTypes?: null | {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  wayOfDeliveryTypes?: null | {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                wayOfDeliveryTypes?: null | {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                }[];
            };
        }
        • application/json: {
              wayOfDeliveryTypes?: null | {
                  code?: null | string;
                  id?: number;
                  name?: null | string;
              }[];
          }
          • Optional wayOfDeliveryTypes?: null | {
                code?: null | string;
                id?: number;
                name?: null | string;
            }[]
Orders_PatchAddOrderClasses: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                classes?: null | {
                    code?: null | string;
                    comment?: null | string;
                    name?: null | string;
                }[];
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Add order classes to an existing order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        OrderId.

  • requestBody: {
        content: {
            application/json: {
                classes?: null | {
                    code?: null | string;
                    comment?: null | string;
                    name?: null | string;
                }[];
            };
        };
    }

    Description

    Object containing the order classes.

    • content: {
          application/json: {
              classes?: null | {
                  code?: null | string;
                  comment?: null | string;
                  name?: null | string;
              }[];
          };
      }
      • application/json: {
            classes?: null | {
                code?: null | string;
                comment?: null | string;
                name?: null | string;
            }[];
        }
        • Optional classes?: null | {
              code?: null | string;
              comment?: null | string;
              name?: null | string;
          }[]
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchDeliveryDate: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody?: {
        content: {
            application/json: {
                deliveryDate: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Update the delivery date of an existing order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        OrderId.

  • Optional requestBody?: {
        content: {
            application/json: {
                deliveryDate: string;
            };
        };
    }

    Description

    Object containing the new delivery date.

    • content: {
          application/json: {
              deliveryDate: string;
          };
      }
      • application/json: {
            deliveryDate: string;
        }
        • deliveryDate: string

          Format: date-time

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchOrderNumber: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                orderNumber: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Update the order number of an existing order. Note that the system will not verify that the order number is unique.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        OrderId.

  • requestBody: {
        content: {
            application/json: {
                orderNumber: string;
            };
        };
    }

    Description

    Object containing the new order number.

    • content: {
          application/json: {
              orderNumber: string;
          };
      }
      • application/json: {
            orderNumber: string;
        }
        • orderNumber: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchOrderStatus: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                orderStatusNumber: number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Update the status of an order. Note that if the warehouse has allocated goods to the order, then it's possible that this call will fail.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        OrderId.

  • requestBody: {
        content: {
            application/json: {
                orderStatusNumber: number;
            };
        };
    }

    Description

    Object containing the new order status.

    • content: {
          application/json: {
              orderStatusNumber: number;
          };
      }
      • application/json: {
            orderStatusNumber: number;
        }
        • orderStatusNumber: number

          Format: int32

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchOrderTransporterCode: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                paymentAdvanced?: {
                    consigneeCollects?: null | boolean;
                    consigneePays?: {
                        customerNumber: string;
                    };
                    thirdPartyPays?: {
                        customerNumber: string;
                    };
                };
                transporterCode?: null | string;
                transporterServiceCode?: null | string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Update the transporter of an existing order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number
  • requestBody: {
        content: {
            application/json: {
                paymentAdvanced?: {
                    consigneeCollects?: null | boolean;
                    consigneePays?: {
                        customerNumber: string;
                    };
                    thirdPartyPays?: {
                        customerNumber: string;
                    };
                };
                transporterCode?: null | string;
                transporterServiceCode?: null | string;
            };
        };
    }
    • content: {
          application/json: {
              paymentAdvanced?: {
                  consigneeCollects?: null | boolean;
                  consigneePays?: {
                      customerNumber: string;
                  };
                  thirdPartyPays?: {
                      customerNumber: string;
                  };
              };
              transporterCode?: null | string;
              transporterServiceCode?: null | string;
          };
      }
      • application/json: {
            paymentAdvanced?: {
                consigneeCollects?: null | boolean;
                consigneePays?: {
                    customerNumber: string;
                };
                thirdPartyPays?: {
                    customerNumber: string;
                };
            };
            transporterCode?: null | string;
            transporterServiceCode?: null | string;
        }
        • Optional paymentAdvanced?: {
              consigneeCollects?: null | boolean;
              consigneePays?: {
                  customerNumber: string;
              };
              thirdPartyPays?: {
                  customerNumber: string;
              };
          }
          • Optional consigneeCollects?: null | boolean
          • Optional consigneePays?: {
                customerNumber: string;
            }
            • customerNumber: string
          • Optional thirdPartyPays?: {
                customerNumber: string;
            }
            • customerNumber: string
        • Optional transporterCode?: null | string
        • Optional transporterServiceCode?: null | string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchReportedNumberOfItems: {
    parameters: {
        path: {
            orderId: number;
            orderLineId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                reportedNumberOfItems: number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Update the reported number of items on a particular order line.

Type declaration

  • parameters: {
        path: {
            orderId: number;
            orderLineId: number;
        };
    }
    • path: {
          orderId: number;
          orderLineId: number;
      }
      • orderId: number

        Description

        Ongoing WMS internal ID of the order

      • orderLineId: number

        Description

        Ongoing WMS internal ID of the order line

  • requestBody: {
        content: {
            application/json: {
                reportedNumberOfItems: number;
            };
        };
    }

    Description

    Object containing the reported number of items

    • content: {
          application/json: {
              reportedNumberOfItems: number;
          };
      }
      • application/json: {
            reportedNumberOfItems: number;
        }
        • reportedNumberOfItems: number

          Format: decimal

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchReportedReturnedNumberOfItems: {
    parameters: {
        path: {
            orderId: number;
            orderLineId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                reportedReturnedNumberOfItems: number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/octet-stream: string;
            };
        };
    };
}

Update the reported returned number of items on a particular order line.

Type declaration

  • parameters: {
        path: {
            orderId: number;
            orderLineId: number;
        };
    }
    • path: {
          orderId: number;
          orderLineId: number;
      }
      • orderId: number

        Description

        Ongoing WMS internal ID of the order

      • orderLineId: number

        Description

        Ongoing WMS internal ID of the order line

  • requestBody: {
        content: {
            application/json: {
                reportedReturnedNumberOfItems: number;
            };
        };
    }

    Description

    Object containing the reported returned number of items

    • content: {
          application/json: {
              reportedReturnedNumberOfItems: number;
          };
      }
      • application/json: {
            reportedReturnedNumberOfItems: number;
        }
        • reportedReturnedNumberOfItems: number

          Format: decimal

  • responses: {
        200: {
            content: {
                application/octet-stream: string;
            };
        };
    }
    • 200: {
          content: {
              application/octet-stream: string;
          };
      }
      • content: {
            application/octet-stream: string;
        }
        • application/octet-stream: string
Orders_PatchReturnWaybill: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                returnWaybill: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Update the return waybill of an existing order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        OrderId.

  • requestBody: {
        content: {
            application/json: {
                returnWaybill: string;
            };
        };
    }

    Description

    Object containing the new return waybill.

    • content: {
          application/json: {
              returnWaybill: string;
          };
      }
      • application/json: {
            returnWaybill: string;
        }
        • returnWaybill: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchServicePointCode: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                servicePointCode: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Update the service point code of an existing order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        OrderId.

  • requestBody: {
        content: {
            application/json: {
                servicePointCode: string;
            };
        };
    }

    Description

    Object containing the new service point code.

    • content: {
          application/json: {
              servicePointCode: string;
          };
      }
      • application/json: {
            servicePointCode: string;
        }
        • servicePointCode: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchSetOrderClasses: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                classes?: null | {
                    code?: null | string;
                    comment?: null | string;
                    name?: null | string;
                }[];
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Set order classes on an existing order. If the order has any other classes which you don't send, they will be deleted from the order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        OrderId.

  • requestBody: {
        content: {
            application/json: {
                classes?: null | {
                    code?: null | string;
                    comment?: null | string;
                    name?: null | string;
                }[];
            };
        };
    }

    Description

    Object containing the order classes.

    • content: {
          application/json: {
              classes?: null | {
                  code?: null | string;
                  comment?: null | string;
                  name?: null | string;
              }[];
          };
      }
      • application/json: {
            classes?: null | {
                code?: null | string;
                comment?: null | string;
                name?: null | string;
            }[];
        }
        • Optional classes?: null | {
              code?: null | string;
              comment?: null | string;
              name?: null | string;
          }[]
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchSetReportedNumberOfItemsToPickedNumberOfItems: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Sets the reported number of items on each order line to the picked number of items.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Ongoing WMS internal ID of the order

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchSetReportedReturnedNumberOfItemsToReturnedNumberOfItems: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Sets the reported returned number of items on each order line to the returned number of items.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Ongoing WMS internal ID of the order

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_PatchWayBillRow: {
    parameters: {
        path: {
            orderId: number;
            wayBillRowId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                approvedNumberOfPackages?: null | number;
                category?: null | string;
                comment?: null | string;
                height?: null | number;
                length?: null | number;
                loadMeters?: null | number;
                numberOfPackages: number;
                parcelType: {
                    code?: null | string;
                    id?: null | number;
                };
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayBillRowId?: number;
                };
            };
        };
    };
}

Update waybill row.

Type declaration

  • parameters: {
        path: {
            orderId: number;
            wayBillRowId: number;
        };
    }
    • path: {
          orderId: number;
          wayBillRowId: number;
      }
      • orderId: number

        Description

        Order ID.

      • wayBillRowId: number

        Description

        Waybill row ID.

  • requestBody: {
        content: {
            application/json: {
                approvedNumberOfPackages?: null | number;
                category?: null | string;
                comment?: null | string;
                height?: null | number;
                length?: null | number;
                loadMeters?: null | number;
                numberOfPackages: number;
                parcelType: {
                    code?: null | string;
                    id?: null | number;
                };
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            };
        };
    }

    Description

    Information about the waybill row.

    • content: {
          application/json: {
              approvedNumberOfPackages?: null | number;
              category?: null | string;
              comment?: null | string;
              height?: null | number;
              length?: null | number;
              loadMeters?: null | number;
              numberOfPackages: number;
              parcelType: {
                  code?: null | string;
                  id?: null | number;
              };
              volume?: null | number;
              weight?: null | number;
              width?: null | number;
          };
      }
      • application/json: {
            approvedNumberOfPackages?: null | number;
            category?: null | string;
            comment?: null | string;
            height?: null | number;
            length?: null | number;
            loadMeters?: null | number;
            numberOfPackages: number;
            parcelType: {
                code?: null | string;
                id?: null | number;
            };
            volume?: null | number;
            weight?: null | number;
            width?: null | number;
        }
        • Optional approvedNumberOfPackages?: null | number

          Format: int32

        • Optional category?: null | string
        • Optional comment?: null | string
        • Optional height?: null | number

          Format: decimal

        • Optional length?: null | number

          Format: decimal

        • Optional loadMeters?: null | number

          Format: decimal

        • numberOfPackages: number

          Format: int32

        • parcelType: {
              code?: null | string;
              id?: null | number;
          }
          • Optional code?: null | string
          • Optional id?: null | number

            Format: int32

        • Optional volume?: null | number

          Format: decimal

        • Optional weight?: null | number

          Format: decimal

        • Optional width?: null | number

          Format: decimal

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayBillRowId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  success?: boolean;
                  wayBillRowId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                success?: boolean;
                wayBillRowId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              success?: boolean;
              wayBillRowId?: number;
          }
          • Optional message?: null | string
          • Optional success?: boolean
          • Optional wayBillRowId?: number

            Format: int32

Orders_PatchWaybill: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                waybill: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    };
}

Update the waybill of an existing order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        OrderId.

  • requestBody: {
        content: {
            application/json: {
                waybill: string;
            };
        };
    }

    Description

    Object containing the new waybill.

    • content: {
          application/json: {
              waybill: string;
          };
      }
      • application/json: {
            waybill: string;
        }
        • waybill: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: number;
          }
          • Optional message?: null | string
          • Optional orderId?: number

            Format: int32

Orders_Post: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Create a new file and attach it to an order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    }

    Description

    File object, containing all file data.

    • content: {
          application/json: {
              advanced?: {
                  printingInfo?: {
                      printAsUser?: {
                          userId?: null | number;
                      };
                      printAsWorkstation?: {
                          workstationId?: null | number;
                      };
                      reportId?: null | number;
                  };
              };
              fileDataBase64: string;
              fileName: string;
              mimeType: string;
          };
      }
      • application/json: {
            advanced?: {
                printingInfo?: {
                    printAsUser?: {
                        userId?: null | number;
                    };
                    printAsWorkstation?: {
                        workstationId?: null | number;
                    };
                    reportId?: null | number;
                };
            };
            fileDataBase64: string;
            fileName: string;
            mimeType: string;
        }
        • Optional advanced?: {
              printingInfo?: {
                  printAsUser?: {
                      userId?: null | number;
                  };
                  printAsWorkstation?: {
                      workstationId?: null | number;
                  };
                  reportId?: null | number;
              };
          }
          • Optional printingInfo?: {
                printAsUser?: {
                    userId?: null | number;
                };
                printAsWorkstation?: {
                    workstationId?: null | number;
                };
                reportId?: null | number;
            }
            • Optional printAsUser?: {
                  userId?: null | number;
              }
              • Optional userId?: null | number

                Format: int32

            • Optional printAsWorkstation?: {
                  workstationId?: null | number;
              }
              • Optional workstationId?: null | number

                Format: int32

            • Optional reportId?: null | number

              Format: int32

        • fileDataBase64: string
        • fileName: string
        • mimeType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
Orders_PostWayBillRow: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                approvedNumberOfPackages?: null | number;
                category?: null | string;
                comment?: null | string;
                height?: null | number;
                length?: null | number;
                loadMeters?: null | number;
                numberOfPackages: number;
                parcelType: {
                    code?: null | string;
                    id?: null | number;
                };
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayBillRowId?: number;
                };
            };
        };
    };
}

Create a waybill row.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • requestBody: {
        content: {
            application/json: {
                approvedNumberOfPackages?: null | number;
                category?: null | string;
                comment?: null | string;
                height?: null | number;
                length?: null | number;
                loadMeters?: null | number;
                numberOfPackages: number;
                parcelType: {
                    code?: null | string;
                    id?: null | number;
                };
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            };
        };
    }

    Description

    Information about the waybill row.

    • content: {
          application/json: {
              approvedNumberOfPackages?: null | number;
              category?: null | string;
              comment?: null | string;
              height?: null | number;
              length?: null | number;
              loadMeters?: null | number;
              numberOfPackages: number;
              parcelType: {
                  code?: null | string;
                  id?: null | number;
              };
              volume?: null | number;
              weight?: null | number;
              width?: null | number;
          };
      }
      • application/json: {
            approvedNumberOfPackages?: null | number;
            category?: null | string;
            comment?: null | string;
            height?: null | number;
            length?: null | number;
            loadMeters?: null | number;
            numberOfPackages: number;
            parcelType: {
                code?: null | string;
                id?: null | number;
            };
            volume?: null | number;
            weight?: null | number;
            width?: null | number;
        }
        • Optional approvedNumberOfPackages?: null | number

          Format: int32

        • Optional category?: null | string
        • Optional comment?: null | string
        • Optional height?: null | number

          Format: decimal

        • Optional length?: null | number

          Format: decimal

        • Optional loadMeters?: null | number

          Format: decimal

        • numberOfPackages: number

          Format: int32

        • parcelType: {
              code?: null | string;
              id?: null | number;
          }
          • Optional code?: null | string
          • Optional id?: null | number

            Format: int32

        • Optional volume?: null | number

          Format: decimal

        • Optional weight?: null | number

          Format: decimal

        • Optional width?: null | number

          Format: decimal

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayBillRowId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  success?: boolean;
                  wayBillRowId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                success?: boolean;
                wayBillRowId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              success?: boolean;
              wayBillRowId?: number;
          }
          • Optional message?: null | string
          • Optional success?: boolean
          • Optional wayBillRowId?: number

            Format: int32

Orders_PutFile: {
    parameters: {
        path: {
            fileId: number;
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Update a file which is attached to an order.

Type declaration

  • parameters: {
        path: {
            fileId: number;
            orderId: number;
        };
    }
    • path: {
          fileId: number;
          orderId: number;
      }
      • fileId: number

        Description

        File ID.

      • orderId: number

        Description

        Order ID.

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    }

    Description

    File object, containing all file data.

    • content: {
          application/json: {
              advanced?: {
                  printingInfo?: {
                      printAsUser?: {
                          userId?: null | number;
                      };
                      printAsWorkstation?: {
                          workstationId?: null | number;
                      };
                      reportId?: null | number;
                  };
              };
              fileDataBase64: string;
              fileName: string;
              mimeType: string;
          };
      }
      • application/json: {
            advanced?: {
                printingInfo?: {
                    printAsUser?: {
                        userId?: null | number;
                    };
                    printAsWorkstation?: {
                        workstationId?: null | number;
                    };
                    reportId?: null | number;
                };
            };
            fileDataBase64: string;
            fileName: string;
            mimeType: string;
        }
        • Optional advanced?: {
              printingInfo?: {
                  printAsUser?: {
                      userId?: null | number;
                  };
                  printAsWorkstation?: {
                      workstationId?: null | number;
                  };
                  reportId?: null | number;
              };
          }
          • Optional printingInfo?: {
                printAsUser?: {
                    userId?: null | number;
                };
                printAsWorkstation?: {
                    workstationId?: null | number;
                };
                reportId?: null | number;
            }
            • Optional printAsUser?: {
                  userId?: null | number;
              }
              • Optional userId?: null | number

                Format: int32

            • Optional printAsWorkstation?: {
                  workstationId?: null | number;
              }
              • Optional workstationId?: null | number

                Format: int32

            • Optional reportId?: null | number

              Format: int32

        • fileDataBase64: string
        • fileName: string
        • mimeType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
Orders_PutFileUsingFilename: {
    parameters: {
        path: {
            orderId: number;
        };
        query: {
            fileName: null | string;
        };
    };
    requestBody: {
        content: {
            application/json: {
                fileDataBase64: string;
                mimeType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Create or update a file which is attached to an order. The filename will be used to check if the file already exists.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
        query: {
            fileName: null | string;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

    • query: {
          fileName: null | string;
      }
      • fileName: null | string

        Description

        File name.

  • requestBody: {
        content: {
            application/json: {
                fileDataBase64: string;
                mimeType: string;
            };
        };
    }

    Description

    File object, containing all file data.

    • content: {
          application/json: {
              fileDataBase64: string;
              mimeType: string;
          };
      }
      • application/json: {
            fileDataBase64: string;
            mimeType: string;
        }
        • fileDataBase64: string
        • mimeType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
Orders_PutOrder: {
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    arrivalDate?: null | string;
                    arrivalDateFrom?: null | string;
                    communication?: null | string;
                    invoiceNumber?: null | string;
                    orderTextLines?: null | {
                        comment?: null | string;
                        numberOfItems?: number;
                        rowNumber: string;
                    }[];
                    termsOfDeliveryString?: null | string;
                    termsOfPaymentString?: null | string;
                    transporterOrderNumber?: null | string;
                    wayOfDeliveryString?: null | string;
                };
                classes?: null | {
                    code?: null | string;
                    comment?: null | string;
                    name?: null | string;
                }[];
                consignee: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    advanced?: {
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        externalCustomerCode?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                    };
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    customerNumber?: null | string;
                    doorCode?: null | string;
                    invoiceAddress?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                value?: null | string;
                            };
                            smsNotification?: {
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        name?: null | string;
                        postCode?: null | string;
                    };
                    name?: null | string;
                    organisationNumber?: null | string;
                    postCode?: null | string;
                    remark?: null | string;
                    vatNumber?: null | string;
                };
                consigneeOrderNumber?: null | string;
                customerPrice?: null | number;
                customsInfo?: {
                    customsValueCurrencyCode?: null | string;
                };
                deliveryDate: string;
                deliveryInstruction?: null | string;
                emailNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                freeText1?: null | string;
                freeText2?: null | string;
                freeText3?: null | string;
                freightPrice?: null | number;
                goodsOwnerId: number;
                goodsOwnerOrderId?: null | string;
                marketPlace?: {
                    marketPlace?: null | string;
                    marketPlaceOrderNumber?: null | string;
                };
                orderFreeDateTime1?: null | string;
                orderLines?: null | {
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleNumber: string;
                    batchNumber?: null | string;
                    comment?: null | string;
                    customerArticleNumber?: null | string;
                    externalId?: null | string;
                    lineFreeValues?: {
                        freeText1?: null | string;
                    };
                    lineTotalCustomsValue?: null | number;
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    numberOfItems?: number;
                    prices?: {
                        currencyCode?: null | string;
                        customerLinePrice?: null | number;
                        discountPercentage?: null | number;
                        linePrice?: null | number;
                    };
                    rowNumber: string;
                    serialNumber?: null | string;
                    shouldBePicked?: null | boolean;
                    warehouseInstruction?: null | string;
                }[];
                orderNumber: string;
                orderRemark?: null | string;
                orderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                pickingPriority?: null | number;
                preparedTransportDocumentId?: null | string;
                productionCode?: null | string;
                referenceNumber?: null | string;
                returnTransporter?: {
                    transporterCode?: null | string;
                    transporterServiceCode?: null | string;
                };
                salesCode?: null | string;
                servicePointCode?: null | string;
                smsNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                telephoneNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                termsOfDeliveryType?: {
                    code?: null | string;
                    name?: null | string;
                };
                transporter?: {
                    paymentAdvanced?: {
                        consigneeCollects?: null | boolean;
                        consigneePays?: {
                            customerNumber: string;
                        };
                        senderPays?: {
                            ediCode: string;
                        };
                        thirdPartyPays?: {
                            customerNumber: string;
                        };
                    };
                    transporterCode?: null | string;
                    transporterServiceCode?: null | string;
                };
                transporterBulkId?: null | string;
                warehouseId?: null | number;
                warehouseInstruction?: null | string;
                wayOfDelivery?: {
                    code?: null | string;
                    name?: null | string;
                };
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
        201: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
    };
}

Create or update an order. If there is no order with the specified order number, it will be created. Otherwise, the existing order will be updated. Note that you are not allowed to update an order after the warehouse has started working on it.

Type declaration

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    arrivalDate?: null | string;
                    arrivalDateFrom?: null | string;
                    communication?: null | string;
                    invoiceNumber?: null | string;
                    orderTextLines?: null | {
                        comment?: null | string;
                        numberOfItems?: number;
                        rowNumber: string;
                    }[];
                    termsOfDeliveryString?: null | string;
                    termsOfPaymentString?: null | string;
                    transporterOrderNumber?: null | string;
                    wayOfDeliveryString?: null | string;
                };
                classes?: null | {
                    code?: null | string;
                    comment?: null | string;
                    name?: null | string;
                }[];
                consignee: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    advanced?: {
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        externalCustomerCode?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                    };
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    customerNumber?: null | string;
                    doorCode?: null | string;
                    invoiceAddress?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                value?: null | string;
                            };
                            smsNotification?: {
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        name?: null | string;
                        postCode?: null | string;
                    };
                    name?: null | string;
                    organisationNumber?: null | string;
                    postCode?: null | string;
                    remark?: null | string;
                    vatNumber?: null | string;
                };
                consigneeOrderNumber?: null | string;
                customerPrice?: null | number;
                customsInfo?: {
                    customsValueCurrencyCode?: null | string;
                };
                deliveryDate: string;
                deliveryInstruction?: null | string;
                emailNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                freeText1?: null | string;
                freeText2?: null | string;
                freeText3?: null | string;
                freightPrice?: null | number;
                goodsOwnerId: number;
                goodsOwnerOrderId?: null | string;
                marketPlace?: {
                    marketPlace?: null | string;
                    marketPlaceOrderNumber?: null | string;
                };
                orderFreeDateTime1?: null | string;
                orderLines?: null | {
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleNumber: string;
                    batchNumber?: null | string;
                    comment?: null | string;
                    customerArticleNumber?: null | string;
                    externalId?: null | string;
                    lineFreeValues?: {
                        freeText1?: null | string;
                    };
                    lineTotalCustomsValue?: null | number;
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    numberOfItems?: number;
                    prices?: {
                        currencyCode?: null | string;
                        customerLinePrice?: null | number;
                        discountPercentage?: null | number;
                        linePrice?: null | number;
                    };
                    rowNumber: string;
                    serialNumber?: null | string;
                    shouldBePicked?: null | boolean;
                    warehouseInstruction?: null | string;
                }[];
                orderNumber: string;
                orderRemark?: null | string;
                orderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                pickingPriority?: null | number;
                preparedTransportDocumentId?: null | string;
                productionCode?: null | string;
                referenceNumber?: null | string;
                returnTransporter?: {
                    transporterCode?: null | string;
                    transporterServiceCode?: null | string;
                };
                salesCode?: null | string;
                servicePointCode?: null | string;
                smsNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                telephoneNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                termsOfDeliveryType?: {
                    code?: null | string;
                    name?: null | string;
                };
                transporter?: {
                    paymentAdvanced?: {
                        consigneeCollects?: null | boolean;
                        consigneePays?: {
                            customerNumber: string;
                        };
                        senderPays?: {
                            ediCode: string;
                        };
                        thirdPartyPays?: {
                            customerNumber: string;
                        };
                    };
                    transporterCode?: null | string;
                    transporterServiceCode?: null | string;
                };
                transporterBulkId?: null | string;
                warehouseId?: null | number;
                warehouseInstruction?: null | string;
                wayOfDelivery?: {
                    code?: null | string;
                    name?: null | string;
                };
            };
        };
    }

    Description

    Order object, containing all order data.

    • content: {
          application/json: {
              advanced?: {
                  arrivalDate?: null | string;
                  arrivalDateFrom?: null | string;
                  communication?: null | string;
                  invoiceNumber?: null | string;
                  orderTextLines?: null | {
                      comment?: null | string;
                      numberOfItems?: number;
                      rowNumber: string;
                  }[];
                  termsOfDeliveryString?: null | string;
                  termsOfPaymentString?: null | string;
                  transporterOrderNumber?: null | string;
                  wayOfDeliveryString?: null | string;
              };
              classes?: null | {
                  code?: null | string;
                  comment?: null | string;
                  name?: null | string;
              }[];
              consignee: {
                  address1?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  advanced?: {
                      emailNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      externalCustomerCode?: null | string;
                      smsNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                  };
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  customerNumber?: null | string;
                  doorCode?: null | string;
                  invoiceAddress?: {
                      address1?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      advanced?: {
                          emailNotification?: {
                              value?: null | string;
                          };
                          smsNotification?: {
                              value?: null | string;
                          };
                          telephoneNotification?: {
                              value?: null | string;
                          };
                      };
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      name?: null | string;
                      postCode?: null | string;
                  };
                  name?: null | string;
                  organisationNumber?: null | string;
                  postCode?: null | string;
                  remark?: null | string;
                  vatNumber?: null | string;
              };
              consigneeOrderNumber?: null | string;
              customerPrice?: null | number;
              customsInfo?: {
                  customsValueCurrencyCode?: null | string;
              };
              deliveryDate: string;
              deliveryInstruction?: null | string;
              emailNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              };
              freeText1?: null | string;
              freeText2?: null | string;
              freeText3?: null | string;
              freightPrice?: null | number;
              goodsOwnerId: number;
              goodsOwnerOrderId?: null | string;
              marketPlace?: {
                  marketPlace?: null | string;
                  marketPlaceOrderNumber?: null | string;
              };
              orderFreeDateTime1?: null | string;
              orderLines?: null | {
                  articleItemStatus?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  articleNumber: string;
                  batchNumber?: null | string;
                  comment?: null | string;
                  customerArticleNumber?: null | string;
                  externalId?: null | string;
                  lineFreeValues?: {
                      freeText1?: null | string;
                  };
                  lineTotalCustomsValue?: null | number;
                  lineType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  numberOfItems?: number;
                  prices?: {
                      currencyCode?: null | string;
                      customerLinePrice?: null | number;
                      discountPercentage?: null | number;
                      linePrice?: null | number;
                  };
                  rowNumber: string;
                  serialNumber?: null | string;
                  shouldBePicked?: null | boolean;
                  warehouseInstruction?: null | string;
              }[];
              orderNumber: string;
              orderRemark?: null | string;
              orderType?: {
                  code?: null | string;
                  name?: null | string;
              };
              pickingPriority?: null | number;
              preparedTransportDocumentId?: null | string;
              productionCode?: null | string;
              referenceNumber?: null | string;
              returnTransporter?: {
                  transporterCode?: null | string;
                  transporterServiceCode?: null | string;
              };
              salesCode?: null | string;
              servicePointCode?: null | string;
              smsNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              };
              telephoneNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              };
              termsOfDeliveryType?: {
                  code?: null | string;
                  name?: null | string;
              };
              transporter?: {
                  paymentAdvanced?: {
                      consigneeCollects?: null | boolean;
                      consigneePays?: {
                          customerNumber: string;
                      };
                      senderPays?: {
                          ediCode: string;
                      };
                      thirdPartyPays?: {
                          customerNumber: string;
                      };
                  };
                  transporterCode?: null | string;
                  transporterServiceCode?: null | string;
              };
              transporterBulkId?: null | string;
              warehouseId?: null | number;
              warehouseInstruction?: null | string;
              wayOfDelivery?: {
                  code?: null | string;
                  name?: null | string;
              };
          };
      }
      • application/json: {
            advanced?: {
                arrivalDate?: null | string;
                arrivalDateFrom?: null | string;
                communication?: null | string;
                invoiceNumber?: null | string;
                orderTextLines?: null | {
                    comment?: null | string;
                    numberOfItems?: number;
                    rowNumber: string;
                }[];
                termsOfDeliveryString?: null | string;
                termsOfPaymentString?: null | string;
                transporterOrderNumber?: null | string;
                wayOfDeliveryString?: null | string;
            };
            classes?: null | {
                code?: null | string;
                comment?: null | string;
                name?: null | string;
            }[];
            consignee: {
                address1?: null | string;
                address2?: null | string;
                address3?: null | string;
                advanced?: {
                    emailNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    externalCustomerCode?: null | string;
                    smsNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    telephoneNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                };
                city?: null | string;
                countryCode?: null | string;
                countryStateCode?: null | string;
                customerNumber?: null | string;
                doorCode?: null | string;
                invoiceAddress?: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    advanced?: {
                        emailNotification?: {
                            value?: null | string;
                        };
                        smsNotification?: {
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            value?: null | string;
                        };
                    };
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    name?: null | string;
                    postCode?: null | string;
                };
                name?: null | string;
                organisationNumber?: null | string;
                postCode?: null | string;
                remark?: null | string;
                vatNumber?: null | string;
            };
            consigneeOrderNumber?: null | string;
            customerPrice?: null | number;
            customsInfo?: {
                customsValueCurrencyCode?: null | string;
            };
            deliveryDate: string;
            deliveryInstruction?: null | string;
            emailNotification?: {
                toBeNotified?: boolean;
                value?: null | string;
            };
            freeText1?: null | string;
            freeText2?: null | string;
            freeText3?: null | string;
            freightPrice?: null | number;
            goodsOwnerId: number;
            goodsOwnerOrderId?: null | string;
            marketPlace?: {
                marketPlace?: null | string;
                marketPlaceOrderNumber?: null | string;
            };
            orderFreeDateTime1?: null | string;
            orderLines?: null | {
                articleItemStatus?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleNumber: string;
                batchNumber?: null | string;
                comment?: null | string;
                customerArticleNumber?: null | string;
                externalId?: null | string;
                lineFreeValues?: {
                    freeText1?: null | string;
                };
                lineTotalCustomsValue?: null | number;
                lineType?: {
                    code?: null | string;
                    name?: null | string;
                };
                numberOfItems?: number;
                prices?: {
                    currencyCode?: null | string;
                    customerLinePrice?: null | number;
                    discountPercentage?: null | number;
                    linePrice?: null | number;
                };
                rowNumber: string;
                serialNumber?: null | string;
                shouldBePicked?: null | boolean;
                warehouseInstruction?: null | string;
            }[];
            orderNumber: string;
            orderRemark?: null | string;
            orderType?: {
                code?: null | string;
                name?: null | string;
            };
            pickingPriority?: null | number;
            preparedTransportDocumentId?: null | string;
            productionCode?: null | string;
            referenceNumber?: null | string;
            returnTransporter?: {
                transporterCode?: null | string;
                transporterServiceCode?: null | string;
            };
            salesCode?: null | string;
            servicePointCode?: null | string;
            smsNotification?: {
                toBeNotified?: boolean;
                value?: null | string;
            };
            telephoneNotification?: {
                toBeNotified?: boolean;
                value?: null | string;
            };
            termsOfDeliveryType?: {
                code?: null | string;
                name?: null | string;
            };
            transporter?: {
                paymentAdvanced?: {
                    consigneeCollects?: null | boolean;
                    consigneePays?: {
                        customerNumber: string;
                    };
                    senderPays?: {
                        ediCode: string;
                    };
                    thirdPartyPays?: {
                        customerNumber: string;
                    };
                };
                transporterCode?: null | string;
                transporterServiceCode?: null | string;
            };
            transporterBulkId?: null | string;
            warehouseId?: null | number;
            warehouseInstruction?: null | string;
            wayOfDelivery?: {
                code?: null | string;
                name?: null | string;
            };
        }
        • Optional advanced?: {
              arrivalDate?: null | string;
              arrivalDateFrom?: null | string;
              communication?: null | string;
              invoiceNumber?: null | string;
              orderTextLines?: null | {
                  comment?: null | string;
                  numberOfItems?: number;
                  rowNumber: string;
              }[];
              termsOfDeliveryString?: null | string;
              termsOfPaymentString?: null | string;
              transporterOrderNumber?: null | string;
              wayOfDeliveryString?: null | string;
          }
          • Optional arrivalDate?: null | string

            Format: date-time

          • Optional arrivalDateFrom?: null | string

            Format: date-time

          • Optional communication?: null | string
          • Optional invoiceNumber?: null | string
          • Optional orderTextLines?: null | {
                comment?: null | string;
                numberOfItems?: number;
                rowNumber: string;
            }[]
          • Optional termsOfDeliveryString?: null | string
          • Optional termsOfPaymentString?: null | string
          • Optional transporterOrderNumber?: null | string
          • Optional wayOfDeliveryString?: null | string
        • Optional classes?: null | {
              code?: null | string;
              comment?: null | string;
              name?: null | string;
          }[]
        • consignee: {
              address1?: null | string;
              address2?: null | string;
              address3?: null | string;
              advanced?: {
                  emailNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  externalCustomerCode?: null | string;
                  smsNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  telephoneNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
              };
              city?: null | string;
              countryCode?: null | string;
              countryStateCode?: null | string;
              customerNumber?: null | string;
              doorCode?: null | string;
              invoiceAddress?: {
                  address1?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  advanced?: {
                      emailNotification?: {
                          value?: null | string;
                      };
                      smsNotification?: {
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          value?: null | string;
                      };
                  };
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  name?: null | string;
                  postCode?: null | string;
              };
              name?: null | string;
              organisationNumber?: null | string;
              postCode?: null | string;
              remark?: null | string;
              vatNumber?: null | string;
          }
          • Optional address1?: null | string
          • Optional address2?: null | string
          • Optional address3?: null | string
          • Optional advanced?: {
                emailNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                externalCustomerCode?: null | string;
                smsNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                telephoneNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
            }
            • Optional emailNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              }
              • Optional toBeNotified?: boolean
              • Optional value?: null | string
            • Optional externalCustomerCode?: null | string
            • Optional smsNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              }
              • Optional toBeNotified?: boolean
              • Optional value?: null | string
            • Optional telephoneNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              }
              • Optional toBeNotified?: boolean
              • Optional value?: null | string
          • Optional city?: null | string
          • Optional countryCode?: null | string
          • Optional countryStateCode?: null | string
          • Optional customerNumber?: null | string
          • Optional doorCode?: null | string
          • Optional invoiceAddress?: {
                address1?: null | string;
                address2?: null | string;
                address3?: null | string;
                advanced?: {
                    emailNotification?: {
                        value?: null | string;
                    };
                    smsNotification?: {
                        value?: null | string;
                    };
                    telephoneNotification?: {
                        value?: null | string;
                    };
                };
                city?: null | string;
                countryCode?: null | string;
                countryStateCode?: null | string;
                name?: null | string;
                postCode?: null | string;
            }
            • Optional address1?: null | string
            • Optional address2?: null | string
            • Optional address3?: null | string
            • Optional advanced?: {
                  emailNotification?: {
                      value?: null | string;
                  };
                  smsNotification?: {
                      value?: null | string;
                  };
                  telephoneNotification?: {
                      value?: null | string;
                  };
              }
              • Optional emailNotification?: {
                    value?: null | string;
                }
                • Optional value?: null | string
              • Optional smsNotification?: {
                    value?: null | string;
                }
                • Optional value?: null | string
              • Optional telephoneNotification?: {
                    value?: null | string;
                }
                • Optional value?: null | string
            • Optional city?: null | string
            • Optional countryCode?: null | string
            • Optional countryStateCode?: null | string
            • Optional name?: null | string
            • Optional postCode?: null | string
          • Optional name?: null | string
          • Optional organisationNumber?: null | string
          • Optional postCode?: null | string
          • Optional remark?: null | string
          • Optional vatNumber?: null | string
        • Optional consigneeOrderNumber?: null | string
        • Optional customerPrice?: null | number

          Format: decimal

        • Optional customsInfo?: {
              customsValueCurrencyCode?: null | string;
          }
          • Optional customsValueCurrencyCode?: null | string
        • deliveryDate: string

          Format: date-time

        • Optional deliveryInstruction?: null | string
        • Optional emailNotification?: {
              toBeNotified?: boolean;
              value?: null | string;
          }
          • Optional toBeNotified?: boolean
          • Optional value?: null | string
        • Optional freeText1?: null | string
        • Optional freeText2?: null | string
        • Optional freeText3?: null | string
        • Optional freightPrice?: null | number

          Format: decimal

        • goodsOwnerId: number

          Format: int32

        • Optional goodsOwnerOrderId?: null | string
        • Optional marketPlace?: {
              marketPlace?: null | string;
              marketPlaceOrderNumber?: null | string;
          }
          • Optional marketPlace?: null | string
          • Optional marketPlaceOrderNumber?: null | string
        • Optional orderFreeDateTime1?: null | string

          Format: date-time

        • Optional orderLines?: null | {
              articleItemStatus?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleNumber: string;
              batchNumber?: null | string;
              comment?: null | string;
              customerArticleNumber?: null | string;
              externalId?: null | string;
              lineFreeValues?: {
                  freeText1?: null | string;
              };
              lineTotalCustomsValue?: null | number;
              lineType?: {
                  code?: null | string;
                  name?: null | string;
              };
              numberOfItems?: number;
              prices?: {
                  currencyCode?: null | string;
                  customerLinePrice?: null | number;
                  discountPercentage?: null | number;
                  linePrice?: null | number;
              };
              rowNumber: string;
              serialNumber?: null | string;
              shouldBePicked?: null | boolean;
              warehouseInstruction?: null | string;
          }[]
        • orderNumber: string
        • Optional orderRemark?: null | string
        • Optional orderType?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional pickingPriority?: null | number

          Format: int32

        • Optional preparedTransportDocumentId?: null | string
        • Optional productionCode?: null | string
        • Optional referenceNumber?: null | string
        • Optional returnTransporter?: {
              transporterCode?: null | string;
              transporterServiceCode?: null | string;
          }
          • Optional transporterCode?: null | string
          • Optional transporterServiceCode?: null | string
        • Optional salesCode?: null | string
        • Optional servicePointCode?: null | string
        • Optional smsNotification?: {
              toBeNotified?: boolean;
              value?: null | string;
          }
          • Optional toBeNotified?: boolean
          • Optional value?: null | string
        • Optional telephoneNotification?: {
              toBeNotified?: boolean;
              value?: null | string;
          }
          • Optional toBeNotified?: boolean
          • Optional value?: null | string
        • Optional termsOfDeliveryType?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional transporter?: {
              paymentAdvanced?: {
                  consigneeCollects?: null | boolean;
                  consigneePays?: {
                      customerNumber: string;
                  };
                  senderPays?: {
                      ediCode: string;
                  };
                  thirdPartyPays?: {
                      customerNumber: string;
                  };
              };
              transporterCode?: null | string;
              transporterServiceCode?: null | string;
          }
          • Optional paymentAdvanced?: {
                consigneeCollects?: null | boolean;
                consigneePays?: {
                    customerNumber: string;
                };
                senderPays?: {
                    ediCode: string;
                };
                thirdPartyPays?: {
                    customerNumber: string;
                };
            }
            • Optional consigneeCollects?: null | boolean
            • Optional consigneePays?: {
                  customerNumber: string;
              }
              • customerNumber: string
            • Optional senderPays?: {
                  ediCode: string;
              }
              • ediCode: string
            • Optional thirdPartyPays?: {
                  customerNumber: string;
              }
              • customerNumber: string
          • Optional transporterCode?: null | string
          • Optional transporterServiceCode?: null | string
        • Optional transporterBulkId?: null | string
        • Optional warehouseId?: null | number

          Format: int32

        • Optional warehouseInstruction?: null | string
        • Optional wayOfDelivery?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
        201: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: null | number;
          }
          • Optional message?: null | string
          • Optional orderId?: null | number

            Format: int32

    • 201: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: null | number;
          }
          • Optional message?: null | string
          • Optional orderId?: null | number

            Format: int32

Orders_PutOrderTracking: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                isReturnTracking: boolean;
                trackingUrl: string;
                waybill: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Create or update a waybill on an order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • requestBody: {
        content: {
            application/json: {
                isReturnTracking: boolean;
                trackingUrl: string;
                waybill: string;
            };
        };
    }

    Description

    Information about the order tracking.

    • content: {
          application/json: {
              isReturnTracking: boolean;
              trackingUrl: string;
              waybill: string;
          };
      }
      • application/json: {
            isReturnTracking: boolean;
            trackingUrl: string;
            waybill: string;
        }
        • isReturnTracking: boolean
        • trackingUrl: string
        • waybill: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              message?: null | string;
              success?: boolean;
          }
          • Optional message?: null | string
          • Optional success?: boolean
Orders_PutOrderUsingOrderId: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    arrivalDate?: null | string;
                    arrivalDateFrom?: null | string;
                    communication?: null | string;
                    invoiceNumber?: null | string;
                    orderTextLines?: null | {
                        comment?: null | string;
                        numberOfItems?: number;
                        rowNumber: string;
                    }[];
                    termsOfDeliveryString?: null | string;
                    termsOfPaymentString?: null | string;
                    transporterOrderNumber?: null | string;
                    wayOfDeliveryString?: null | string;
                };
                classes?: null | {
                    code?: null | string;
                    comment?: null | string;
                    name?: null | string;
                }[];
                consignee: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    advanced?: {
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        externalCustomerCode?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                    };
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    customerNumber?: null | string;
                    doorCode?: null | string;
                    invoiceAddress?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                value?: null | string;
                            };
                            smsNotification?: {
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        name?: null | string;
                        postCode?: null | string;
                    };
                    name?: null | string;
                    organisationNumber?: null | string;
                    postCode?: null | string;
                    remark?: null | string;
                    vatNumber?: null | string;
                };
                consigneeOrderNumber?: null | string;
                customerPrice?: null | number;
                customsInfo?: {
                    customsValueCurrencyCode?: null | string;
                };
                deliveryDate: string;
                deliveryInstruction?: null | string;
                emailNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                freeText1?: null | string;
                freeText2?: null | string;
                freeText3?: null | string;
                freightPrice?: null | number;
                goodsOwnerId: number;
                goodsOwnerOrderId?: null | string;
                marketPlace?: {
                    marketPlace?: null | string;
                    marketPlaceOrderNumber?: null | string;
                };
                orderFreeDateTime1?: null | string;
                orderLines?: null | {
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleNumber: string;
                    batchNumber?: null | string;
                    comment?: null | string;
                    customerArticleNumber?: null | string;
                    externalId?: null | string;
                    lineFreeValues?: {
                        freeText1?: null | string;
                    };
                    lineTotalCustomsValue?: null | number;
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    numberOfItems?: number;
                    prices?: {
                        currencyCode?: null | string;
                        customerLinePrice?: null | number;
                        discountPercentage?: null | number;
                        linePrice?: null | number;
                    };
                    rowNumber: string;
                    serialNumber?: null | string;
                    shouldBePicked?: null | boolean;
                    warehouseInstruction?: null | string;
                }[];
                orderNumber: string;
                orderRemark?: null | string;
                orderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                pickingPriority?: null | number;
                preparedTransportDocumentId?: null | string;
                productionCode?: null | string;
                referenceNumber?: null | string;
                returnTransporter?: {
                    transporterCode?: null | string;
                    transporterServiceCode?: null | string;
                };
                salesCode?: null | string;
                servicePointCode?: null | string;
                smsNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                telephoneNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                termsOfDeliveryType?: {
                    code?: null | string;
                    name?: null | string;
                };
                transporter?: {
                    paymentAdvanced?: {
                        consigneeCollects?: null | boolean;
                        consigneePays?: {
                            customerNumber: string;
                        };
                        senderPays?: {
                            ediCode: string;
                        };
                        thirdPartyPays?: {
                            customerNumber: string;
                        };
                    };
                    transporterCode?: null | string;
                    transporterServiceCode?: null | string;
                };
                transporterBulkId?: null | string;
                warehouseId?: null | number;
                warehouseInstruction?: null | string;
                wayOfDelivery?: {
                    code?: null | string;
                    name?: null | string;
                };
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
    };
}

Update an order. Note that you are not allowed to update an order after the warehouse has started working on it.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    arrivalDate?: null | string;
                    arrivalDateFrom?: null | string;
                    communication?: null | string;
                    invoiceNumber?: null | string;
                    orderTextLines?: null | {
                        comment?: null | string;
                        numberOfItems?: number;
                        rowNumber: string;
                    }[];
                    termsOfDeliveryString?: null | string;
                    termsOfPaymentString?: null | string;
                    transporterOrderNumber?: null | string;
                    wayOfDeliveryString?: null | string;
                };
                classes?: null | {
                    code?: null | string;
                    comment?: null | string;
                    name?: null | string;
                }[];
                consignee: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    advanced?: {
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        externalCustomerCode?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                    };
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    customerNumber?: null | string;
                    doorCode?: null | string;
                    invoiceAddress?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        advanced?: {
                            emailNotification?: {
                                value?: null | string;
                            };
                            smsNotification?: {
                                value?: null | string;
                            };
                            telephoneNotification?: {
                                value?: null | string;
                            };
                        };
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        name?: null | string;
                        postCode?: null | string;
                    };
                    name?: null | string;
                    organisationNumber?: null | string;
                    postCode?: null | string;
                    remark?: null | string;
                    vatNumber?: null | string;
                };
                consigneeOrderNumber?: null | string;
                customerPrice?: null | number;
                customsInfo?: {
                    customsValueCurrencyCode?: null | string;
                };
                deliveryDate: string;
                deliveryInstruction?: null | string;
                emailNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                freeText1?: null | string;
                freeText2?: null | string;
                freeText3?: null | string;
                freightPrice?: null | number;
                goodsOwnerId: number;
                goodsOwnerOrderId?: null | string;
                marketPlace?: {
                    marketPlace?: null | string;
                    marketPlaceOrderNumber?: null | string;
                };
                orderFreeDateTime1?: null | string;
                orderLines?: null | {
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleNumber: string;
                    batchNumber?: null | string;
                    comment?: null | string;
                    customerArticleNumber?: null | string;
                    externalId?: null | string;
                    lineFreeValues?: {
                        freeText1?: null | string;
                    };
                    lineTotalCustomsValue?: null | number;
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    numberOfItems?: number;
                    prices?: {
                        currencyCode?: null | string;
                        customerLinePrice?: null | number;
                        discountPercentage?: null | number;
                        linePrice?: null | number;
                    };
                    rowNumber: string;
                    serialNumber?: null | string;
                    shouldBePicked?: null | boolean;
                    warehouseInstruction?: null | string;
                }[];
                orderNumber: string;
                orderRemark?: null | string;
                orderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                pickingPriority?: null | number;
                preparedTransportDocumentId?: null | string;
                productionCode?: null | string;
                referenceNumber?: null | string;
                returnTransporter?: {
                    transporterCode?: null | string;
                    transporterServiceCode?: null | string;
                };
                salesCode?: null | string;
                servicePointCode?: null | string;
                smsNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                telephoneNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                termsOfDeliveryType?: {
                    code?: null | string;
                    name?: null | string;
                };
                transporter?: {
                    paymentAdvanced?: {
                        consigneeCollects?: null | boolean;
                        consigneePays?: {
                            customerNumber: string;
                        };
                        senderPays?: {
                            ediCode: string;
                        };
                        thirdPartyPays?: {
                            customerNumber: string;
                        };
                    };
                    transporterCode?: null | string;
                    transporterServiceCode?: null | string;
                };
                transporterBulkId?: null | string;
                warehouseId?: null | number;
                warehouseInstruction?: null | string;
                wayOfDelivery?: {
                    code?: null | string;
                    name?: null | string;
                };
            };
        };
    }

    Description

    Order object, containing all order data.

    • content: {
          application/json: {
              advanced?: {
                  arrivalDate?: null | string;
                  arrivalDateFrom?: null | string;
                  communication?: null | string;
                  invoiceNumber?: null | string;
                  orderTextLines?: null | {
                      comment?: null | string;
                      numberOfItems?: number;
                      rowNumber: string;
                  }[];
                  termsOfDeliveryString?: null | string;
                  termsOfPaymentString?: null | string;
                  transporterOrderNumber?: null | string;
                  wayOfDeliveryString?: null | string;
              };
              classes?: null | {
                  code?: null | string;
                  comment?: null | string;
                  name?: null | string;
              }[];
              consignee: {
                  address1?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  advanced?: {
                      emailNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      externalCustomerCode?: null | string;
                      smsNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                  };
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  customerNumber?: null | string;
                  doorCode?: null | string;
                  invoiceAddress?: {
                      address1?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      advanced?: {
                          emailNotification?: {
                              value?: null | string;
                          };
                          smsNotification?: {
                              value?: null | string;
                          };
                          telephoneNotification?: {
                              value?: null | string;
                          };
                      };
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      name?: null | string;
                      postCode?: null | string;
                  };
                  name?: null | string;
                  organisationNumber?: null | string;
                  postCode?: null | string;
                  remark?: null | string;
                  vatNumber?: null | string;
              };
              consigneeOrderNumber?: null | string;
              customerPrice?: null | number;
              customsInfo?: {
                  customsValueCurrencyCode?: null | string;
              };
              deliveryDate: string;
              deliveryInstruction?: null | string;
              emailNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              };
              freeText1?: null | string;
              freeText2?: null | string;
              freeText3?: null | string;
              freightPrice?: null | number;
              goodsOwnerId: number;
              goodsOwnerOrderId?: null | string;
              marketPlace?: {
                  marketPlace?: null | string;
                  marketPlaceOrderNumber?: null | string;
              };
              orderFreeDateTime1?: null | string;
              orderLines?: null | {
                  articleItemStatus?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  articleNumber: string;
                  batchNumber?: null | string;
                  comment?: null | string;
                  customerArticleNumber?: null | string;
                  externalId?: null | string;
                  lineFreeValues?: {
                      freeText1?: null | string;
                  };
                  lineTotalCustomsValue?: null | number;
                  lineType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  numberOfItems?: number;
                  prices?: {
                      currencyCode?: null | string;
                      customerLinePrice?: null | number;
                      discountPercentage?: null | number;
                      linePrice?: null | number;
                  };
                  rowNumber: string;
                  serialNumber?: null | string;
                  shouldBePicked?: null | boolean;
                  warehouseInstruction?: null | string;
              }[];
              orderNumber: string;
              orderRemark?: null | string;
              orderType?: {
                  code?: null | string;
                  name?: null | string;
              };
              pickingPriority?: null | number;
              preparedTransportDocumentId?: null | string;
              productionCode?: null | string;
              referenceNumber?: null | string;
              returnTransporter?: {
                  transporterCode?: null | string;
                  transporterServiceCode?: null | string;
              };
              salesCode?: null | string;
              servicePointCode?: null | string;
              smsNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              };
              telephoneNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              };
              termsOfDeliveryType?: {
                  code?: null | string;
                  name?: null | string;
              };
              transporter?: {
                  paymentAdvanced?: {
                      consigneeCollects?: null | boolean;
                      consigneePays?: {
                          customerNumber: string;
                      };
                      senderPays?: {
                          ediCode: string;
                      };
                      thirdPartyPays?: {
                          customerNumber: string;
                      };
                  };
                  transporterCode?: null | string;
                  transporterServiceCode?: null | string;
              };
              transporterBulkId?: null | string;
              warehouseId?: null | number;
              warehouseInstruction?: null | string;
              wayOfDelivery?: {
                  code?: null | string;
                  name?: null | string;
              };
          };
      }
      • application/json: {
            advanced?: {
                arrivalDate?: null | string;
                arrivalDateFrom?: null | string;
                communication?: null | string;
                invoiceNumber?: null | string;
                orderTextLines?: null | {
                    comment?: null | string;
                    numberOfItems?: number;
                    rowNumber: string;
                }[];
                termsOfDeliveryString?: null | string;
                termsOfPaymentString?: null | string;
                transporterOrderNumber?: null | string;
                wayOfDeliveryString?: null | string;
            };
            classes?: null | {
                code?: null | string;
                comment?: null | string;
                name?: null | string;
            }[];
            consignee: {
                address1?: null | string;
                address2?: null | string;
                address3?: null | string;
                advanced?: {
                    emailNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    externalCustomerCode?: null | string;
                    smsNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    telephoneNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                };
                city?: null | string;
                countryCode?: null | string;
                countryStateCode?: null | string;
                customerNumber?: null | string;
                doorCode?: null | string;
                invoiceAddress?: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    advanced?: {
                        emailNotification?: {
                            value?: null | string;
                        };
                        smsNotification?: {
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            value?: null | string;
                        };
                    };
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    name?: null | string;
                    postCode?: null | string;
                };
                name?: null | string;
                organisationNumber?: null | string;
                postCode?: null | string;
                remark?: null | string;
                vatNumber?: null | string;
            };
            consigneeOrderNumber?: null | string;
            customerPrice?: null | number;
            customsInfo?: {
                customsValueCurrencyCode?: null | string;
            };
            deliveryDate: string;
            deliveryInstruction?: null | string;
            emailNotification?: {
                toBeNotified?: boolean;
                value?: null | string;
            };
            freeText1?: null | string;
            freeText2?: null | string;
            freeText3?: null | string;
            freightPrice?: null | number;
            goodsOwnerId: number;
            goodsOwnerOrderId?: null | string;
            marketPlace?: {
                marketPlace?: null | string;
                marketPlaceOrderNumber?: null | string;
            };
            orderFreeDateTime1?: null | string;
            orderLines?: null | {
                articleItemStatus?: {
                    code?: null | string;
                    name?: null | string;
                };
                articleNumber: string;
                batchNumber?: null | string;
                comment?: null | string;
                customerArticleNumber?: null | string;
                externalId?: null | string;
                lineFreeValues?: {
                    freeText1?: null | string;
                };
                lineTotalCustomsValue?: null | number;
                lineType?: {
                    code?: null | string;
                    name?: null | string;
                };
                numberOfItems?: number;
                prices?: {
                    currencyCode?: null | string;
                    customerLinePrice?: null | number;
                    discountPercentage?: null | number;
                    linePrice?: null | number;
                };
                rowNumber: string;
                serialNumber?: null | string;
                shouldBePicked?: null | boolean;
                warehouseInstruction?: null | string;
            }[];
            orderNumber: string;
            orderRemark?: null | string;
            orderType?: {
                code?: null | string;
                name?: null | string;
            };
            pickingPriority?: null | number;
            preparedTransportDocumentId?: null | string;
            productionCode?: null | string;
            referenceNumber?: null | string;
            returnTransporter?: {
                transporterCode?: null | string;
                transporterServiceCode?: null | string;
            };
            salesCode?: null | string;
            servicePointCode?: null | string;
            smsNotification?: {
                toBeNotified?: boolean;
                value?: null | string;
            };
            telephoneNotification?: {
                toBeNotified?: boolean;
                value?: null | string;
            };
            termsOfDeliveryType?: {
                code?: null | string;
                name?: null | string;
            };
            transporter?: {
                paymentAdvanced?: {
                    consigneeCollects?: null | boolean;
                    consigneePays?: {
                        customerNumber: string;
                    };
                    senderPays?: {
                        ediCode: string;
                    };
                    thirdPartyPays?: {
                        customerNumber: string;
                    };
                };
                transporterCode?: null | string;
                transporterServiceCode?: null | string;
            };
            transporterBulkId?: null | string;
            warehouseId?: null | number;
            warehouseInstruction?: null | string;
            wayOfDelivery?: {
                code?: null | string;
                name?: null | string;
            };
        }
        • Optional advanced?: {
              arrivalDate?: null | string;
              arrivalDateFrom?: null | string;
              communication?: null | string;
              invoiceNumber?: null | string;
              orderTextLines?: null | {
                  comment?: null | string;
                  numberOfItems?: number;
                  rowNumber: string;
              }[];
              termsOfDeliveryString?: null | string;
              termsOfPaymentString?: null | string;
              transporterOrderNumber?: null | string;
              wayOfDeliveryString?: null | string;
          }
          • Optional arrivalDate?: null | string

            Format: date-time

          • Optional arrivalDateFrom?: null | string

            Format: date-time

          • Optional communication?: null | string
          • Optional invoiceNumber?: null | string
          • Optional orderTextLines?: null | {
                comment?: null | string;
                numberOfItems?: number;
                rowNumber: string;
            }[]
          • Optional termsOfDeliveryString?: null | string
          • Optional termsOfPaymentString?: null | string
          • Optional transporterOrderNumber?: null | string
          • Optional wayOfDeliveryString?: null | string
        • Optional classes?: null | {
              code?: null | string;
              comment?: null | string;
              name?: null | string;
          }[]
        • consignee: {
              address1?: null | string;
              address2?: null | string;
              address3?: null | string;
              advanced?: {
                  emailNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  externalCustomerCode?: null | string;
                  smsNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  telephoneNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
              };
              city?: null | string;
              countryCode?: null | string;
              countryStateCode?: null | string;
              customerNumber?: null | string;
              doorCode?: null | string;
              invoiceAddress?: {
                  address1?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  advanced?: {
                      emailNotification?: {
                          value?: null | string;
                      };
                      smsNotification?: {
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          value?: null | string;
                      };
                  };
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  name?: null | string;
                  postCode?: null | string;
              };
              name?: null | string;
              organisationNumber?: null | string;
              postCode?: null | string;
              remark?: null | string;
              vatNumber?: null | string;
          }
          • Optional address1?: null | string
          • Optional address2?: null | string
          • Optional address3?: null | string
          • Optional advanced?: {
                emailNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                externalCustomerCode?: null | string;
                smsNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
                telephoneNotification?: {
                    toBeNotified?: boolean;
                    value?: null | string;
                };
            }
            • Optional emailNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              }
              • Optional toBeNotified?: boolean
              • Optional value?: null | string
            • Optional externalCustomerCode?: null | string
            • Optional smsNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              }
              • Optional toBeNotified?: boolean
              • Optional value?: null | string
            • Optional telephoneNotification?: {
                  toBeNotified?: boolean;
                  value?: null | string;
              }
              • Optional toBeNotified?: boolean
              • Optional value?: null | string
          • Optional city?: null | string
          • Optional countryCode?: null | string
          • Optional countryStateCode?: null | string
          • Optional customerNumber?: null | string
          • Optional doorCode?: null | string
          • Optional invoiceAddress?: {
                address1?: null | string;
                address2?: null | string;
                address3?: null | string;
                advanced?: {
                    emailNotification?: {
                        value?: null | string;
                    };
                    smsNotification?: {
                        value?: null | string;
                    };
                    telephoneNotification?: {
                        value?: null | string;
                    };
                };
                city?: null | string;
                countryCode?: null | string;
                countryStateCode?: null | string;
                name?: null | string;
                postCode?: null | string;
            }
            • Optional address1?: null | string
            • Optional address2?: null | string
            • Optional address3?: null | string
            • Optional advanced?: {
                  emailNotification?: {
                      value?: null | string;
                  };
                  smsNotification?: {
                      value?: null | string;
                  };
                  telephoneNotification?: {
                      value?: null | string;
                  };
              }
              • Optional emailNotification?: {
                    value?: null | string;
                }
                • Optional value?: null | string
              • Optional smsNotification?: {
                    value?: null | string;
                }
                • Optional value?: null | string
              • Optional telephoneNotification?: {
                    value?: null | string;
                }
                • Optional value?: null | string
            • Optional city?: null | string
            • Optional countryCode?: null | string
            • Optional countryStateCode?: null | string
            • Optional name?: null | string
            • Optional postCode?: null | string
          • Optional name?: null | string
          • Optional organisationNumber?: null | string
          • Optional postCode?: null | string
          • Optional remark?: null | string
          • Optional vatNumber?: null | string
        • Optional consigneeOrderNumber?: null | string
        • Optional customerPrice?: null | number

          Format: decimal

        • Optional customsInfo?: {
              customsValueCurrencyCode?: null | string;
          }
          • Optional customsValueCurrencyCode?: null | string
        • deliveryDate: string

          Format: date-time

        • Optional deliveryInstruction?: null | string
        • Optional emailNotification?: {
              toBeNotified?: boolean;
              value?: null | string;
          }
          • Optional toBeNotified?: boolean
          • Optional value?: null | string
        • Optional freeText1?: null | string
        • Optional freeText2?: null | string
        • Optional freeText3?: null | string
        • Optional freightPrice?: null | number

          Format: decimal

        • goodsOwnerId: number

          Format: int32

        • Optional goodsOwnerOrderId?: null | string
        • Optional marketPlace?: {
              marketPlace?: null | string;
              marketPlaceOrderNumber?: null | string;
          }
          • Optional marketPlace?: null | string
          • Optional marketPlaceOrderNumber?: null | string
        • Optional orderFreeDateTime1?: null | string

          Format: date-time

        • Optional orderLines?: null | {
              articleItemStatus?: {
                  code?: null | string;
                  name?: null | string;
              };
              articleNumber: string;
              batchNumber?: null | string;
              comment?: null | string;
              customerArticleNumber?: null | string;
              externalId?: null | string;
              lineFreeValues?: {
                  freeText1?: null | string;
              };
              lineTotalCustomsValue?: null | number;
              lineType?: {
                  code?: null | string;
                  name?: null | string;
              };
              numberOfItems?: number;
              prices?: {
                  currencyCode?: null | string;
                  customerLinePrice?: null | number;
                  discountPercentage?: null | number;
                  linePrice?: null | number;
              };
              rowNumber: string;
              serialNumber?: null | string;
              shouldBePicked?: null | boolean;
              warehouseInstruction?: null | string;
          }[]
        • orderNumber: string
        • Optional orderRemark?: null | string
        • Optional orderType?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional pickingPriority?: null | number

          Format: int32

        • Optional preparedTransportDocumentId?: null | string
        • Optional productionCode?: null | string
        • Optional referenceNumber?: null | string
        • Optional returnTransporter?: {
              transporterCode?: null | string;
              transporterServiceCode?: null | string;
          }
          • Optional transporterCode?: null | string
          • Optional transporterServiceCode?: null | string
        • Optional salesCode?: null | string
        • Optional servicePointCode?: null | string
        • Optional smsNotification?: {
              toBeNotified?: boolean;
              value?: null | string;
          }
          • Optional toBeNotified?: boolean
          • Optional value?: null | string
        • Optional telephoneNotification?: {
              toBeNotified?: boolean;
              value?: null | string;
          }
          • Optional toBeNotified?: boolean
          • Optional value?: null | string
        • Optional termsOfDeliveryType?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional transporter?: {
              paymentAdvanced?: {
                  consigneeCollects?: null | boolean;
                  consigneePays?: {
                      customerNumber: string;
                  };
                  senderPays?: {
                      ediCode: string;
                  };
                  thirdPartyPays?: {
                      customerNumber: string;
                  };
              };
              transporterCode?: null | string;
              transporterServiceCode?: null | string;
          }
          • Optional paymentAdvanced?: {
                consigneeCollects?: null | boolean;
                consigneePays?: {
                    customerNumber: string;
                };
                senderPays?: {
                    ediCode: string;
                };
                thirdPartyPays?: {
                    customerNumber: string;
                };
            }
            • Optional consigneeCollects?: null | boolean
            • Optional consigneePays?: {
                  customerNumber: string;
              }
              • customerNumber: string
            • Optional senderPays?: {
                  ediCode: string;
              }
              • ediCode: string
            • Optional thirdPartyPays?: {
                  customerNumber: string;
              }
              • customerNumber: string
          • Optional transporterCode?: null | string
          • Optional transporterServiceCode?: null | string
        • Optional transporterBulkId?: null | string
        • Optional warehouseId?: null | number

          Format: int32

        • Optional warehouseInstruction?: null | string
        • Optional wayOfDelivery?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    orderId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  orderId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                orderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              orderId?: null | number;
          }
          • Optional message?: null | string
          • Optional orderId?: null | number

            Format: int32

Orders_PutParcel: {
    parameters: {
        path: {
            orderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    parcelStatus?: {
                        code?: null | string;
                        id?: null | number;
                    };
                    parcelType?: {
                        code?: null | string;
                        id?: null | number;
                    };
                };
                parcelNumber: string;
                transportAdministrationType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    parcelId?: number;
                    success?: boolean;
                };
            };
        };
    };
}

Create or update a parcel on an order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
        };
    }
    • path: {
          orderId: number;
      }
      • orderId: number

        Description

        Order ID.

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    parcelStatus?: {
                        code?: null | string;
                        id?: null | number;
                    };
                    parcelType?: {
                        code?: null | string;
                        id?: null | number;
                    };
                };
                parcelNumber: string;
                transportAdministrationType: string;
            };
        };
    }

    Description

    Information about the parcel.

    • content: {
          application/json: {
              advanced?: {
                  parcelStatus?: {
                      code?: null | string;
                      id?: null | number;
                  };
                  parcelType?: {
                      code?: null | string;
                      id?: null | number;
                  };
              };
              parcelNumber: string;
              transportAdministrationType: string;
          };
      }
      • application/json: {
            advanced?: {
                parcelStatus?: {
                    code?: null | string;
                    id?: null | number;
                };
                parcelType?: {
                    code?: null | string;
                    id?: null | number;
                };
            };
            parcelNumber: string;
            transportAdministrationType: string;
        }
        • Optional advanced?: {
              parcelStatus?: {
                  code?: null | string;
                  id?: null | number;
              };
              parcelType?: {
                  code?: null | string;
                  id?: null | number;
              };
          }
          • Optional parcelStatus?: {
                code?: null | string;
                id?: null | number;
            }
            • Optional code?: null | string
            • Optional id?: null | number

              Format: int32

          • Optional parcelType?: {
                code?: null | string;
                id?: null | number;
            }
            • Optional code?: null | string
            • Optional id?: null | number

              Format: int32

        • parcelNumber: string
        • transportAdministrationType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    parcelId?: number;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  parcelId?: number;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                parcelId?: number;
                success?: boolean;
            };
        }
        • application/json: {
              message?: null | string;
              parcelId?: number;
              success?: boolean;
          }
          • Optional message?: null | string
          • Optional parcelId?: number

            Format: int32

          • Optional success?: boolean
Orders_PutParcelUsingId: {
    parameters: {
        path: {
            orderId: number;
            parcelId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    parcelStatus?: {
                        code?: null | string;
                        id?: null | number;
                    };
                    parcelType?: {
                        code?: null | string;
                        id?: null | number;
                    };
                };
                parcelNumber?: null | string;
                transportAdministrationType?: null | string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    parcelId?: number;
                    success?: boolean;
                };
            };
        };
    };
}

Update a parcel on an order.

Type declaration

  • parameters: {
        path: {
            orderId: number;
            parcelId: number;
        };
    }
    • path: {
          orderId: number;
          parcelId: number;
      }
      • orderId: number

        Description

        Order ID.

      • parcelId: number

        Description

        Parcel ID

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    parcelStatus?: {
                        code?: null | string;
                        id?: null | number;
                    };
                    parcelType?: {
                        code?: null | string;
                        id?: null | number;
                    };
                };
                parcelNumber?: null | string;
                transportAdministrationType?: null | string;
            };
        };
    }

    Description

    Information about the parcel.

    • content: {
          application/json: {
              advanced?: {
                  parcelStatus?: {
                      code?: null | string;
                      id?: null | number;
                  };
                  parcelType?: {
                      code?: null | string;
                      id?: null | number;
                  };
              };
              parcelNumber?: null | string;
              transportAdministrationType?: null | string;
          };
      }
      • application/json: {
            advanced?: {
                parcelStatus?: {
                    code?: null | string;
                    id?: null | number;
                };
                parcelType?: {
                    code?: null | string;
                    id?: null | number;
                };
            };
            parcelNumber?: null | string;
            transportAdministrationType?: null | string;
        }
        • Optional advanced?: {
              parcelStatus?: {
                  code?: null | string;
                  id?: null | number;
              };
              parcelType?: {
                  code?: null | string;
                  id?: null | number;
              };
          }
          • Optional parcelStatus?: {
                code?: null | string;
                id?: null | number;
            }
            • Optional code?: null | string
            • Optional id?: null | number

              Format: int32

          • Optional parcelType?: {
                code?: null | string;
                id?: null | number;
            }
            • Optional code?: null | string
            • Optional id?: null | number

              Format: int32

        • Optional parcelNumber?: null | string
        • Optional transportAdministrationType?: null | string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    parcelId?: number;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  parcelId?: number;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                parcelId?: number;
                success?: boolean;
            };
        }
        • application/json: {
              message?: null | string;
              parcelId?: number;
              success?: boolean;
          }
          • Optional message?: null | string
          • Optional parcelId?: number

            Format: int32

          • Optional success?: boolean
Orders_PutWayOfDeliveryType: {
    requestBody: {
        content: {
            application/json: {
                code: string;
                goodsOwnerId: number;
                name: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayOfDeliveryTypeId?: null | number;
                };
            };
        };
    };
}

Create or update a way of delivery type. If there is no way of delivery type with the specified code, it will be created. Otherwise, the existing way of delivery type will be updated.

Type declaration

  • requestBody: {
        content: {
            application/json: {
                code: string;
                goodsOwnerId: number;
                name: string;
            };
        };
    }

    Description

    An object containing the way of delivery type data.

    • content: {
          application/json: {
              code: string;
              goodsOwnerId: number;
              name: string;
          };
      }
      • application/json: {
            code: string;
            goodsOwnerId: number;
            name: string;
        }
        • code: string
        • goodsOwnerId: number

          Format: int32

        • name: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayOfDeliveryTypeId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  success?: boolean;
                  wayOfDeliveryTypeId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                success?: boolean;
                wayOfDeliveryTypeId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              success?: boolean;
              wayOfDeliveryTypeId?: null | number;
          }
          • Optional message?: null | string
          • Optional success?: boolean
          • Optional wayOfDeliveryTypeId?: null | number

            Format: int32

Orders_PutWayOfDeliveryTypeUsingId: {
    parameters: {
        path: {
            wayOfDeliveryTypeId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                code: string;
                goodsOwnerId: number;
                name: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayOfDeliveryTypeId?: null | number;
                };
            };
        };
    };
}

Update a way of delivery type. The ID will be used to identify the way of delivery type.

Type declaration

  • parameters: {
        path: {
            wayOfDeliveryTypeId: number;
        };
    }
    • path: {
          wayOfDeliveryTypeId: number;
      }
      • wayOfDeliveryTypeId: number

        Description

        Way of delivery type ID.

  • requestBody: {
        content: {
            application/json: {
                code: string;
                goodsOwnerId: number;
                name: string;
            };
        };
    }

    Description

    An object containing the way of delivery type data.

    • content: {
          application/json: {
              code: string;
              goodsOwnerId: number;
              name: string;
          };
      }
      • application/json: {
            code: string;
            goodsOwnerId: number;
            name: string;
        }
        • code: string
        • goodsOwnerId: number

          Format: int32

        • name: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    success?: boolean;
                    wayOfDeliveryTypeId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  success?: boolean;
                  wayOfDeliveryTypeId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                success?: boolean;
                wayOfDeliveryTypeId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              success?: boolean;
              wayOfDeliveryTypeId?: null | number;
          }
          • Optional message?: null | string
          • Optional success?: boolean
          • Optional wayOfDeliveryTypeId?: null | number

            Format: int32

ParcelTypes_GetParcelTypes: {
    parameters: {
        query: {
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    area?: null | number;
                    barCode?: null | string;
                    code?: null | string;
                    height?: null | number;
                    id?: number;
                    length?: null | number;
                    loadMeters?: null | number;
                    name?: null | string;
                    weight?: null | number;
                    width?: null | number;
                }[];
            };
        };
    };
}

Get all parcel types which are valid for a particular goods owner.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
        };
    }
    • query: {
          goodsOwnerId: number;
      }
      • goodsOwnerId: number
  • responses: {
        200: {
            content: {
                application/json: null | {
                    area?: null | number;
                    barCode?: null | string;
                    code?: null | string;
                    height?: null | number;
                    id?: number;
                    length?: null | number;
                    loadMeters?: null | number;
                    name?: null | string;
                    weight?: null | number;
                    width?: null | number;
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  area?: null | number;
                  barCode?: null | string;
                  code?: null | string;
                  height?: null | number;
                  id?: number;
                  length?: null | number;
                  loadMeters?: null | number;
                  name?: null | string;
                  weight?: null | number;
                  width?: null | number;
              }[];
          };
      }

      Description

      A list of parcel types

      • content: {
            application/json: null | {
                area?: null | number;
                barCode?: null | string;
                code?: null | string;
                height?: null | number;
                id?: number;
                length?: null | number;
                loadMeters?: null | number;
                name?: null | string;
                weight?: null | number;
                width?: null | number;
            }[];
        }
        • application/json: null | {
              area?: null | number;
              barCode?: null | string;
              code?: null | string;
              height?: null | number;
              id?: number;
              length?: null | number;
              loadMeters?: null | number;
              name?: null | string;
              weight?: null | number;
              width?: null | number;
          }[]
PurchaseOrders_Delete: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: null | number;
                };
            };
        };
    };
}

Cancel a purchase order.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        Purchase order ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  purchaseOrderId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                purchaseOrderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              purchaseOrderId?: null | number;
          }
          • Optional message?: null | string
          • Optional purchaseOrderId?: null | number

            Format: int32

PurchaseOrders_DeleteByOrderNumber: {
    parameters: {
        query: {
            goodsOwnerId: number;
            purchaseOrderNumber: null | string;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: null | number;
                };
            };
        };
    };
}

Cancel a purchase order using the purchase order number.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
            purchaseOrderNumber: null | string;
        };
    }
    • query: {
          goodsOwnerId: number;
          purchaseOrderNumber: null | string;
      }
      • goodsOwnerId: number

        Description

        Goods owner ID.

      • purchaseOrderNumber: null | string

        Description

        Purchase order number.

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  purchaseOrderId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                purchaseOrderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              purchaseOrderId?: null | number;
          }
          • Optional message?: null | string
          • Optional purchaseOrderId?: null | number

            Format: int32

PurchaseOrders_Get: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    purchaseOrderInfo?: {
                        advanced?: {
                            arrivalDate?: null | string;
                            container?: null | string;
                            orderDate?: null | string;
                            purchaseOrderIsReturnType?: boolean;
                        };
                        createdDate?: null | string;
                        freeValues?: {
                            freeBool1?: null | boolean;
                            freeBool2?: null | boolean;
                            freeDecimal1?: null | number;
                            freeDecimal2?: null | number;
                            freeText1?: null | string;
                            freeText2?: null | string;
                            freeText3?: null | string;
                            freeText4?: null | string;
                            freeText5?: null | string;
                        };
                        goodsOwnerReference?: null | string;
                        inDate?: null | string;
                        purchaseOrderId?: number;
                        purchaseOrderNumber?: null | string;
                        purchaseOrderRemark?: null | string;
                        purchaseOrderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        purchaseOrderType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        referenceNumber?: null | string;
                        supplierOrderNumber?: null | string;
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    };
                    purchaseOrderLines?: null | {
                        advisedNumberOfItems?: number;
                        article?: {
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                            productCode?: null | string;
                        };
                        articleItems?: null | {
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batchNumber?: null | string;
                            caseNumber?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            inDate?: string;
                            location?: null | string;
                            numberOfItems?: number;
                            originalArticleItemId?: number;
                            serial?: null | string;
                            weight?: null | number;
                        }[];
                        comment?: null | string;
                        externalOrderLineId?: null | string;
                        freeValues?: {
                            freeText1?: null | string;
                            freeText2?: null | string;
                        };
                        id?: number;
                        lineType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        receivedNumberOfItems?: number;
                        reportedNumberOfItems?: null | number;
                        rowNumber?: null | string;
                        rowPrice?: null | number;
                        subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
                    }[];
                    sellerInfo?: {
                        sellerName?: null | string;
                        sellerNumber?: null | string;
                    };
                    supplierInfo?: {
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    };
                };
            };
        };
    };
}

Get a purchase order.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        Purchase order ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    purchaseOrderInfo?: {
                        advanced?: {
                            arrivalDate?: null | string;
                            container?: null | string;
                            orderDate?: null | string;
                            purchaseOrderIsReturnType?: boolean;
                        };
                        createdDate?: null | string;
                        freeValues?: {
                            freeBool1?: null | boolean;
                            freeBool2?: null | boolean;
                            freeDecimal1?: null | number;
                            freeDecimal2?: null | number;
                            freeText1?: null | string;
                            freeText2?: null | string;
                            freeText3?: null | string;
                            freeText4?: null | string;
                            freeText5?: null | string;
                        };
                        goodsOwnerReference?: null | string;
                        inDate?: null | string;
                        purchaseOrderId?: number;
                        purchaseOrderNumber?: null | string;
                        purchaseOrderRemark?: null | string;
                        purchaseOrderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        purchaseOrderType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        referenceNumber?: null | string;
                        supplierOrderNumber?: null | string;
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    };
                    purchaseOrderLines?: null | {
                        advisedNumberOfItems?: number;
                        article?: {
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                            productCode?: null | string;
                        };
                        articleItems?: null | {
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batchNumber?: null | string;
                            caseNumber?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            inDate?: string;
                            location?: null | string;
                            numberOfItems?: number;
                            originalArticleItemId?: number;
                            serial?: null | string;
                            weight?: null | number;
                        }[];
                        comment?: null | string;
                        externalOrderLineId?: null | string;
                        freeValues?: {
                            freeText1?: null | string;
                            freeText2?: null | string;
                        };
                        id?: number;
                        lineType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        receivedNumberOfItems?: number;
                        reportedNumberOfItems?: null | number;
                        rowNumber?: null | string;
                        rowPrice?: null | number;
                        subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
                    }[];
                    sellerInfo?: {
                        sellerName?: null | string;
                        sellerNumber?: null | string;
                    };
                    supplierInfo?: {
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    };
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  goodsOwner?: {
                      id?: number;
                      name?: null | string;
                  };
                  purchaseOrderInfo?: {
                      advanced?: {
                          arrivalDate?: null | string;
                          container?: null | string;
                          orderDate?: null | string;
                          purchaseOrderIsReturnType?: boolean;
                      };
                      createdDate?: null | string;
                      freeValues?: {
                          freeBool1?: null | boolean;
                          freeBool2?: null | boolean;
                          freeDecimal1?: null | number;
                          freeDecimal2?: null | number;
                          freeText1?: null | string;
                          freeText2?: null | string;
                          freeText3?: null | string;
                          freeText4?: null | string;
                          freeText5?: null | string;
                      };
                      goodsOwnerReference?: null | string;
                      inDate?: null | string;
                      purchaseOrderId?: number;
                      purchaseOrderNumber?: null | string;
                      purchaseOrderRemark?: null | string;
                      purchaseOrderStatus?: {
                          number?: number;
                          text?: null | string;
                      };
                      purchaseOrderType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      referenceNumber?: null | string;
                      supplierOrderNumber?: null | string;
                      warehouse?: {
                          code?: null | string;
                          id?: number;
                          name?: null | string;
                      };
                  };
                  purchaseOrderLines?: null | {
                      advisedNumberOfItems?: number;
                      article?: {
                          articleName?: null | string;
                          articleNumber?: null | string;
                          articleSystemId?: number;
                          productCode?: null | string;
                      };
                      articleItems?: null | {
                          articleItemStatus?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          batchNumber?: null | string;
                          caseNumber?: null | string;
                          comment?: null | string;
                          container?: null | string;
                          expiryDate?: null | string;
                          inDate?: string;
                          location?: null | string;
                          numberOfItems?: number;
                          originalArticleItemId?: number;
                          serial?: null | string;
                          weight?: null | number;
                      }[];
                      comment?: null | string;
                      externalOrderLineId?: null | string;
                      freeValues?: {
                          freeText1?: null | string;
                          freeText2?: null | string;
                      };
                      id?: number;
                      lineType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      receivedNumberOfItems?: number;
                      reportedNumberOfItems?: null | number;
                      rowNumber?: null | string;
                      rowPrice?: null | number;
                      subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
                  }[];
                  sellerInfo?: {
                      sellerName?: null | string;
                      sellerNumber?: null | string;
                  };
                  supplierInfo?: {
                      supplierName?: null | string;
                      supplierNumber?: null | string;
                  };
              };
          };
      }
      • content: {
            application/json: {
                goodsOwner?: {
                    id?: number;
                    name?: null | string;
                };
                purchaseOrderInfo?: {
                    advanced?: {
                        arrivalDate?: null | string;
                        container?: null | string;
                        orderDate?: null | string;
                        purchaseOrderIsReturnType?: boolean;
                    };
                    createdDate?: null | string;
                    freeValues?: {
                        freeBool1?: null | boolean;
                        freeBool2?: null | boolean;
                        freeDecimal1?: null | number;
                        freeDecimal2?: null | number;
                        freeText1?: null | string;
                        freeText2?: null | string;
                        freeText3?: null | string;
                        freeText4?: null | string;
                        freeText5?: null | string;
                    };
                    goodsOwnerReference?: null | string;
                    inDate?: null | string;
                    purchaseOrderId?: number;
                    purchaseOrderNumber?: null | string;
                    purchaseOrderRemark?: null | string;
                    purchaseOrderStatus?: {
                        number?: number;
                        text?: null | string;
                    };
                    purchaseOrderType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    referenceNumber?: null | string;
                    supplierOrderNumber?: null | string;
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                };
                purchaseOrderLines?: null | {
                    advisedNumberOfItems?: number;
                    article?: {
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        productCode?: null | string;
                    };
                    articleItems?: null | {
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batchNumber?: null | string;
                        caseNumber?: null | string;
                        comment?: null | string;
                        container?: null | string;
                        expiryDate?: null | string;
                        inDate?: string;
                        location?: null | string;
                        numberOfItems?: number;
                        originalArticleItemId?: number;
                        serial?: null | string;
                        weight?: null | number;
                    }[];
                    comment?: null | string;
                    externalOrderLineId?: null | string;
                    freeValues?: {
                        freeText1?: null | string;
                        freeText2?: null | string;
                    };
                    id?: number;
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    receivedNumberOfItems?: number;
                    reportedNumberOfItems?: null | number;
                    rowNumber?: null | string;
                    rowPrice?: null | number;
                    subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
                }[];
                sellerInfo?: {
                    sellerName?: null | string;
                    sellerNumber?: null | string;
                };
                supplierInfo?: {
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
            };
        }
        • application/json: {
              goodsOwner?: {
                  id?: number;
                  name?: null | string;
              };
              purchaseOrderInfo?: {
                  advanced?: {
                      arrivalDate?: null | string;
                      container?: null | string;
                      orderDate?: null | string;
                      purchaseOrderIsReturnType?: boolean;
                  };
                  createdDate?: null | string;
                  freeValues?: {
                      freeBool1?: null | boolean;
                      freeBool2?: null | boolean;
                      freeDecimal1?: null | number;
                      freeDecimal2?: null | number;
                      freeText1?: null | string;
                      freeText2?: null | string;
                      freeText3?: null | string;
                      freeText4?: null | string;
                      freeText5?: null | string;
                  };
                  goodsOwnerReference?: null | string;
                  inDate?: null | string;
                  purchaseOrderId?: number;
                  purchaseOrderNumber?: null | string;
                  purchaseOrderRemark?: null | string;
                  purchaseOrderStatus?: {
                      number?: number;
                      text?: null | string;
                  };
                  purchaseOrderType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  referenceNumber?: null | string;
                  supplierOrderNumber?: null | string;
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
              };
              purchaseOrderLines?: null | {
                  advisedNumberOfItems?: number;
                  article?: {
                      articleName?: null | string;
                      articleNumber?: null | string;
                      articleSystemId?: number;
                      productCode?: null | string;
                  };
                  articleItems?: null | {
                      articleItemStatus?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      batchNumber?: null | string;
                      caseNumber?: null | string;
                      comment?: null | string;
                      container?: null | string;
                      expiryDate?: null | string;
                      inDate?: string;
                      location?: null | string;
                      numberOfItems?: number;
                      originalArticleItemId?: number;
                      serial?: null | string;
                      weight?: null | number;
                  }[];
                  comment?: null | string;
                  externalOrderLineId?: null | string;
                  freeValues?: {
                      freeText1?: null | string;
                      freeText2?: null | string;
                  };
                  id?: number;
                  lineType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  receivedNumberOfItems?: number;
                  reportedNumberOfItems?: null | number;
                  rowNumber?: null | string;
                  rowPrice?: null | number;
                  subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
              }[];
              sellerInfo?: {
                  sellerName?: null | string;
                  sellerNumber?: null | string;
              };
              supplierInfo?: {
                  supplierName?: null | string;
                  supplierNumber?: null | string;
              };
          }
          • Optional goodsOwner?: {
                id?: number;
                name?: null | string;
            }
            • Optional id?: number

              Format: int32

            • Optional name?: null | string
          • Optional purchaseOrderInfo?: {
                advanced?: {
                    arrivalDate?: null | string;
                    container?: null | string;
                    orderDate?: null | string;
                    purchaseOrderIsReturnType?: boolean;
                };
                createdDate?: null | string;
                freeValues?: {
                    freeBool1?: null | boolean;
                    freeBool2?: null | boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeText1?: null | string;
                    freeText2?: null | string;
                    freeText3?: null | string;
                    freeText4?: null | string;
                    freeText5?: null | string;
                };
                goodsOwnerReference?: null | string;
                inDate?: null | string;
                purchaseOrderId?: number;
                purchaseOrderNumber?: null | string;
                purchaseOrderRemark?: null | string;
                purchaseOrderStatus?: {
                    number?: number;
                    text?: null | string;
                };
                purchaseOrderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                referenceNumber?: null | string;
                supplierOrderNumber?: null | string;
                warehouse?: {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                };
            }
            • Optional advanced?: {
                  arrivalDate?: null | string;
                  container?: null | string;
                  orderDate?: null | string;
                  purchaseOrderIsReturnType?: boolean;
              }
              • Optional arrivalDate?: null | string

                Format: date-time

              • Optional container?: null | string
              • Optional orderDate?: null | string

                Format: date-time

              • Optional purchaseOrderIsReturnType?: boolean
            • Optional createdDate?: null | string

              Format: date-time

            • Optional freeValues?: {
                  freeBool1?: null | boolean;
                  freeBool2?: null | boolean;
                  freeDecimal1?: null | number;
                  freeDecimal2?: null | number;
                  freeText1?: null | string;
                  freeText2?: null | string;
                  freeText3?: null | string;
                  freeText4?: null | string;
                  freeText5?: null | string;
              }
              • Optional freeBool1?: null | boolean
              • Optional freeBool2?: null | boolean
              • Optional freeDecimal1?: null | number

                Format: decimal

              • Optional freeDecimal2?: null | number

                Format: decimal

              • Optional freeText1?: null | string
              • Optional freeText2?: null | string
              • Optional freeText3?: null | string
              • Optional freeText4?: null | string
              • Optional freeText5?: null | string
            • Optional goodsOwnerReference?: null | string
            • Optional inDate?: null | string

              Format: date-time

            • Optional purchaseOrderId?: number

              Format: int32

            • Optional purchaseOrderNumber?: null | string
            • Optional purchaseOrderRemark?: null | string
            • Optional purchaseOrderStatus?: {
                  number?: number;
                  text?: null | string;
              }
              • Optional number?: number

                Format: int32

              • Optional text?: null | string
            • Optional purchaseOrderType?: {
                  code?: null | string;
                  name?: null | string;
              }
              • Optional code?: null | string
              • Optional name?: null | string
            • Optional referenceNumber?: null | string
            • Optional supplierOrderNumber?: null | string
            • Optional warehouse?: {
                  code?: null | string;
                  id?: number;
                  name?: null | string;
              }
              • Optional code?: null | string
              • Optional id?: number

                Format: int32

              • Optional name?: null | string
          • Optional purchaseOrderLines?: null | {
                advisedNumberOfItems?: number;
                article?: {
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                    productCode?: null | string;
                };
                articleItems?: null | {
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    batchNumber?: null | string;
                    caseNumber?: null | string;
                    comment?: null | string;
                    container?: null | string;
                    expiryDate?: null | string;
                    inDate?: string;
                    location?: null | string;
                    numberOfItems?: number;
                    originalArticleItemId?: number;
                    serial?: null | string;
                    weight?: null | number;
                }[];
                comment?: null | string;
                externalOrderLineId?: null | string;
                freeValues?: {
                    freeText1?: null | string;
                    freeText2?: null | string;
                };
                id?: number;
                lineType?: {
                    code?: null | string;
                    name?: null | string;
                };
                receivedNumberOfItems?: number;
                reportedNumberOfItems?: null | number;
                rowNumber?: null | string;
                rowPrice?: null | number;
                subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
            }[]
          • Optional sellerInfo?: {
                sellerName?: null | string;
                sellerNumber?: null | string;
            }
            • Optional sellerName?: null | string
            • Optional sellerNumber?: null | string
          • Optional supplierInfo?: {
                supplierName?: null | string;
                supplierNumber?: null | string;
            }
            • Optional supplierName?: null | string
            • Optional supplierNumber?: null | string
PurchaseOrders_GetAll: {
    parameters: {
        query: {
            articleNumbers?: null | string[];
            goodsOwnerId: number;
            inDateFrom?: null | string;
            inDateTo?: null | string;
            lastReceiveTimeFrom?: null | string;
            lastReceiveTimeTo?: null | string;
            maxPurchaseOrdersToGet?: null | number;
            onlyPurchaseOrdersWithOrderLinesToReport?: null | boolean;
            purchaseOrderIdFrom?: null | number;
            purchaseOrderNumber?: null | string;
            purchaseOrderNumbers?: null | string[];
            purchaseOrderStatusChangedTimeFrom?: null | string;
            purchaseOrderStatusFrom?: null | number;
            purchaseOrderStatusTo?: null | number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    purchaseOrderInfo?: {
                        advanced?: {
                            arrivalDate?: null | string;
                            container?: null | string;
                            orderDate?: null | string;
                            purchaseOrderIsReturnType?: boolean;
                        };
                        createdDate?: null | string;
                        freeValues?: {
                            freeBool1?: null | boolean;
                            freeBool2?: null | boolean;
                            freeDecimal1?: null | number;
                            freeDecimal2?: null | number;
                            freeText1?: null | string;
                            freeText2?: null | string;
                            freeText3?: null | string;
                            freeText4?: null | string;
                            freeText5?: null | string;
                        };
                        goodsOwnerReference?: null | string;
                        inDate?: null | string;
                        purchaseOrderId?: number;
                        purchaseOrderNumber?: null | string;
                        purchaseOrderRemark?: null | string;
                        purchaseOrderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        purchaseOrderType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        referenceNumber?: null | string;
                        supplierOrderNumber?: null | string;
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    };
                    purchaseOrderLines?: null | {
                        advisedNumberOfItems?: number;
                        article?: {
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                            productCode?: null | string;
                        };
                        articleItems?: null | {
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batchNumber?: null | string;
                            caseNumber?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            inDate?: string;
                            location?: null | string;
                            numberOfItems?: number;
                            originalArticleItemId?: number;
                            serial?: null | string;
                            weight?: null | number;
                        }[];
                        comment?: null | string;
                        externalOrderLineId?: null | string;
                        freeValues?: {
                            freeText1?: null | string;
                            freeText2?: null | string;
                        };
                        id?: number;
                        lineType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        receivedNumberOfItems?: number;
                        reportedNumberOfItems?: null | number;
                        rowNumber?: null | string;
                        rowPrice?: null | number;
                        subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
                    }[];
                    sellerInfo?: {
                        sellerName?: null | string;
                        sellerNumber?: null | string;
                    };
                    supplierInfo?: {
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    };
                }[];
            };
        };
    };
}

Get all purchase orders which match the specified search criteria.

Type declaration

  • parameters: {
        query: {
            articleNumbers?: null | string[];
            goodsOwnerId: number;
            inDateFrom?: null | string;
            inDateTo?: null | string;
            lastReceiveTimeFrom?: null | string;
            lastReceiveTimeTo?: null | string;
            maxPurchaseOrdersToGet?: null | number;
            onlyPurchaseOrdersWithOrderLinesToReport?: null | boolean;
            purchaseOrderIdFrom?: null | number;
            purchaseOrderNumber?: null | string;
            purchaseOrderNumbers?: null | string[];
            purchaseOrderStatusChangedTimeFrom?: null | string;
            purchaseOrderStatusFrom?: null | number;
            purchaseOrderStatusTo?: null | number;
        };
    }
    • query: {
          articleNumbers?: null | string[];
          goodsOwnerId: number;
          inDateFrom?: null | string;
          inDateTo?: null | string;
          lastReceiveTimeFrom?: null | string;
          lastReceiveTimeTo?: null | string;
          maxPurchaseOrdersToGet?: null | number;
          onlyPurchaseOrdersWithOrderLinesToReport?: null | boolean;
          purchaseOrderIdFrom?: null | number;
          purchaseOrderNumber?: null | string;
          purchaseOrderNumbers?: null | string[];
          purchaseOrderStatusChangedTimeFrom?: null | string;
          purchaseOrderStatusFrom?: null | number;
          purchaseOrderStatusTo?: null | number;
      }
      • Optional articleNumbers?: null | string[]

        Description

        Filter for purchase orders which contains at least one of these article numbers.

      • goodsOwnerId: number

        Description

        Goods owner ID.

      • Optional inDateFrom?: null | string

        Description

        Filter for purchase orders where the expected indate is after this date.

      • Optional inDateTo?: null | string

        Description

        Filter for purchase orders where the expected indate is before this date.

      • Optional lastReceiveTimeFrom?: null | string

        Description

        Filter for purchase orders where goods have been received after this time.

      • Optional lastReceiveTimeTo?: null | string

        Description

        Filter for purchase orders where goods have been received before this time.

      • Optional maxPurchaseOrdersToGet?: null | number

        Description

        The maximum number of purchase orders to return.

      • Optional onlyPurchaseOrdersWithOrderLinesToReport?: null | boolean

        Description

        Filter for purchase orders where at least one line has ReportedNumberOfItems != ReceivedNumberOfItems.

      • Optional purchaseOrderIdFrom?: null | number

        Description

        Only return purchase orders whose purcahse order ID is greater than or equal to this.

      • Optional purchaseOrderNumber?: null | string

        Description

        Purchase order number.

      • Optional purchaseOrderNumbers?: null | string[]
      • Optional purchaseOrderStatusChangedTimeFrom?: null | string

        Description

        Only return purchase orders whose status has changed after this time.

      • Optional purchaseOrderStatusFrom?: null | number

        Description

        Filter for purchase orders whose order status is greater than or equal to this.

      • Optional purchaseOrderStatusTo?: null | number

        Description

        Filter for purchase orders whose order status is less than or equal to this.

  • responses: {
        200: {
            content: {
                application/json: null | {
                    goodsOwner?: {
                        id?: number;
                        name?: null | string;
                    };
                    purchaseOrderInfo?: {
                        advanced?: {
                            arrivalDate?: null | string;
                            container?: null | string;
                            orderDate?: null | string;
                            purchaseOrderIsReturnType?: boolean;
                        };
                        createdDate?: null | string;
                        freeValues?: {
                            freeBool1?: null | boolean;
                            freeBool2?: null | boolean;
                            freeDecimal1?: null | number;
                            freeDecimal2?: null | number;
                            freeText1?: null | string;
                            freeText2?: null | string;
                            freeText3?: null | string;
                            freeText4?: null | string;
                            freeText5?: null | string;
                        };
                        goodsOwnerReference?: null | string;
                        inDate?: null | string;
                        purchaseOrderId?: number;
                        purchaseOrderNumber?: null | string;
                        purchaseOrderRemark?: null | string;
                        purchaseOrderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        purchaseOrderType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        referenceNumber?: null | string;
                        supplierOrderNumber?: null | string;
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    };
                    purchaseOrderLines?: null | {
                        advisedNumberOfItems?: number;
                        article?: {
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                            productCode?: null | string;
                        };
                        articleItems?: null | {
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batchNumber?: null | string;
                            caseNumber?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            inDate?: string;
                            location?: null | string;
                            numberOfItems?: number;
                            originalArticleItemId?: number;
                            serial?: null | string;
                            weight?: null | number;
                        }[];
                        comment?: null | string;
                        externalOrderLineId?: null | string;
                        freeValues?: {
                            freeText1?: null | string;
                            freeText2?: null | string;
                        };
                        id?: number;
                        lineType?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        receivedNumberOfItems?: number;
                        reportedNumberOfItems?: null | number;
                        rowNumber?: null | string;
                        rowPrice?: null | number;
                        subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
                    }[];
                    sellerInfo?: {
                        sellerName?: null | string;
                        sellerNumber?: null | string;
                    };
                    supplierInfo?: {
                        supplierName?: null | string;
                        supplierNumber?: null | string;
                    };
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  goodsOwner?: {
                      id?: number;
                      name?: null | string;
                  };
                  purchaseOrderInfo?: {
                      advanced?: {
                          arrivalDate?: null | string;
                          container?: null | string;
                          orderDate?: null | string;
                          purchaseOrderIsReturnType?: boolean;
                      };
                      createdDate?: null | string;
                      freeValues?: {
                          freeBool1?: null | boolean;
                          freeBool2?: null | boolean;
                          freeDecimal1?: null | number;
                          freeDecimal2?: null | number;
                          freeText1?: null | string;
                          freeText2?: null | string;
                          freeText3?: null | string;
                          freeText4?: null | string;
                          freeText5?: null | string;
                      };
                      goodsOwnerReference?: null | string;
                      inDate?: null | string;
                      purchaseOrderId?: number;
                      purchaseOrderNumber?: null | string;
                      purchaseOrderRemark?: null | string;
                      purchaseOrderStatus?: {
                          number?: number;
                          text?: null | string;
                      };
                      purchaseOrderType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      referenceNumber?: null | string;
                      supplierOrderNumber?: null | string;
                      warehouse?: {
                          code?: null | string;
                          id?: number;
                          name?: null | string;
                      };
                  };
                  purchaseOrderLines?: null | {
                      advisedNumberOfItems?: number;
                      article?: {
                          articleName?: null | string;
                          articleNumber?: null | string;
                          articleSystemId?: number;
                          productCode?: null | string;
                      };
                      articleItems?: null | {
                          articleItemStatus?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          batchNumber?: null | string;
                          caseNumber?: null | string;
                          comment?: null | string;
                          container?: null | string;
                          expiryDate?: null | string;
                          inDate?: string;
                          location?: null | string;
                          numberOfItems?: number;
                          originalArticleItemId?: number;
                          serial?: null | string;
                          weight?: null | number;
                      }[];
                      comment?: null | string;
                      externalOrderLineId?: null | string;
                      freeValues?: {
                          freeText1?: null | string;
                          freeText2?: null | string;
                      };
                      id?: number;
                      lineType?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      receivedNumberOfItems?: number;
                      reportedNumberOfItems?: null | number;
                      rowNumber?: null | string;
                      rowPrice?: null | number;
                      subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
                  }[];
                  sellerInfo?: {
                      sellerName?: null | string;
                      sellerNumber?: null | string;
                  };
                  supplierInfo?: {
                      supplierName?: null | string;
                      supplierNumber?: null | string;
                  };
              }[];
          };
      }
      • content: {
            application/json: null | {
                goodsOwner?: {
                    id?: number;
                    name?: null | string;
                };
                purchaseOrderInfo?: {
                    advanced?: {
                        arrivalDate?: null | string;
                        container?: null | string;
                        orderDate?: null | string;
                        purchaseOrderIsReturnType?: boolean;
                    };
                    createdDate?: null | string;
                    freeValues?: {
                        freeBool1?: null | boolean;
                        freeBool2?: null | boolean;
                        freeDecimal1?: null | number;
                        freeDecimal2?: null | number;
                        freeText1?: null | string;
                        freeText2?: null | string;
                        freeText3?: null | string;
                        freeText4?: null | string;
                        freeText5?: null | string;
                    };
                    goodsOwnerReference?: null | string;
                    inDate?: null | string;
                    purchaseOrderId?: number;
                    purchaseOrderNumber?: null | string;
                    purchaseOrderRemark?: null | string;
                    purchaseOrderStatus?: {
                        number?: number;
                        text?: null | string;
                    };
                    purchaseOrderType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    referenceNumber?: null | string;
                    supplierOrderNumber?: null | string;
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                };
                purchaseOrderLines?: null | {
                    advisedNumberOfItems?: number;
                    article?: {
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                        productCode?: null | string;
                    };
                    articleItems?: null | {
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batchNumber?: null | string;
                        caseNumber?: null | string;
                        comment?: null | string;
                        container?: null | string;
                        expiryDate?: null | string;
                        inDate?: string;
                        location?: null | string;
                        numberOfItems?: number;
                        originalArticleItemId?: number;
                        serial?: null | string;
                        weight?: null | number;
                    }[];
                    comment?: null | string;
                    externalOrderLineId?: null | string;
                    freeValues?: {
                        freeText1?: null | string;
                        freeText2?: null | string;
                    };
                    id?: number;
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    receivedNumberOfItems?: number;
                    reportedNumberOfItems?: null | number;
                    rowNumber?: null | string;
                    rowPrice?: null | number;
                    subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
                }[];
                sellerInfo?: {
                    sellerName?: null | string;
                    sellerNumber?: null | string;
                };
                supplierInfo?: {
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
            }[];
        }
        • application/json: null | {
              goodsOwner?: {
                  id?: number;
                  name?: null | string;
              };
              purchaseOrderInfo?: {
                  advanced?: {
                      arrivalDate?: null | string;
                      container?: null | string;
                      orderDate?: null | string;
                      purchaseOrderIsReturnType?: boolean;
                  };
                  createdDate?: null | string;
                  freeValues?: {
                      freeBool1?: null | boolean;
                      freeBool2?: null | boolean;
                      freeDecimal1?: null | number;
                      freeDecimal2?: null | number;
                      freeText1?: null | string;
                      freeText2?: null | string;
                      freeText3?: null | string;
                      freeText4?: null | string;
                      freeText5?: null | string;
                  };
                  goodsOwnerReference?: null | string;
                  inDate?: null | string;
                  purchaseOrderId?: number;
                  purchaseOrderNumber?: null | string;
                  purchaseOrderRemark?: null | string;
                  purchaseOrderStatus?: {
                      number?: number;
                      text?: null | string;
                  };
                  purchaseOrderType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  referenceNumber?: null | string;
                  supplierOrderNumber?: null | string;
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
              };
              purchaseOrderLines?: null | {
                  advisedNumberOfItems?: number;
                  article?: {
                      articleName?: null | string;
                      articleNumber?: null | string;
                      articleSystemId?: number;
                      productCode?: null | string;
                  };
                  articleItems?: null | {
                      articleItemStatus?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      batchNumber?: null | string;
                      caseNumber?: null | string;
                      comment?: null | string;
                      container?: null | string;
                      expiryDate?: null | string;
                      inDate?: string;
                      location?: null | string;
                      numberOfItems?: number;
                      originalArticleItemId?: number;
                      serial?: null | string;
                      weight?: null | number;
                  }[];
                  comment?: null | string;
                  externalOrderLineId?: null | string;
                  freeValues?: {
                      freeText1?: null | string;
                      freeText2?: null | string;
                  };
                  id?: number;
                  lineType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  receivedNumberOfItems?: number;
                  reportedNumberOfItems?: null | number;
                  rowNumber?: null | string;
                  rowPrice?: null | number;
                  subPurchaseOrderLines?: null | ({ id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; })[];
              }[];
              sellerInfo?: {
                  sellerName?: null | string;
                  sellerNumber?: null | string;
              };
              supplierInfo?: {
                  supplierName?: null | string;
                  supplierNumber?: null | string;
              };
          }[]
PurchaseOrders_GetFiles: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    articleSystemId?: null | number;
                    fileDataBase64?: null | string;
                    fileId?: number;
                    fileName?: null | string;
                    mimeType?: null | string;
                    orderId?: null | number;
                    purchaseOrderId?: null | number;
                }[];
            };
        };
    };
}

Get all files which are attached to a specific purchase order.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        Purchase order ID.

  • responses: {
        200: {
            content: {
                application/json: null | {
                    articleSystemId?: null | number;
                    fileDataBase64?: null | string;
                    fileId?: number;
                    fileName?: null | string;
                    mimeType?: null | string;
                    orderId?: null | number;
                    purchaseOrderId?: null | number;
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  articleSystemId?: null | number;
                  fileDataBase64?: null | string;
                  fileId?: number;
                  fileName?: null | string;
                  mimeType?: null | string;
                  orderId?: null | number;
                  purchaseOrderId?: null | number;
              }[];
          };
      }
      • content: {
            application/json: null | {
                articleSystemId?: null | number;
                fileDataBase64?: null | string;
                fileId?: number;
                fileName?: null | string;
                mimeType?: null | string;
                orderId?: null | number;
                purchaseOrderId?: null | number;
            }[];
        }
        • application/json: null | {
              articleSystemId?: null | number;
              fileDataBase64?: null | string;
              fileId?: number;
              fileName?: null | string;
              mimeType?: null | string;
              orderId?: null | number;
              purchaseOrderId?: null | number;
          }[]
PurchaseOrders_GetPurchaseOrderStatuses: {
    responses: {
        200: {
            content: {
                application/json: {
                    orderStatuses?: null | {
                        number?: number;
                        text?: null | string;
                    }[];
                };
            };
        };
    };
}

Get all purchase order statuses.

Type declaration

  • responses: {
        200: {
            content: {
                application/json: {
                    orderStatuses?: null | {
                        number?: number;
                        text?: null | string;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  orderStatuses?: null | {
                      number?: number;
                      text?: null | string;
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                orderStatuses?: null | {
                    number?: number;
                    text?: null | string;
                }[];
            };
        }
        • application/json: {
              orderStatuses?: null | {
                  number?: number;
                  text?: null | string;
              }[];
          }
          • Optional orderStatuses?: null | {
                number?: number;
                text?: null | string;
            }[]
PurchaseOrders_GetPurchaseOrderTypes: {
    parameters: {
        query: {
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    purchaseOrderTypes?: null | ({
                        code?: null | string;
                        name?: null | string;
                    } & Record<string, never>)[];
                };
            };
        };
    };
}

Get all purchase order types for a particular goods owner.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
        };
    }
    • query: {
          goodsOwnerId: number;
      }
      • goodsOwnerId: number
  • responses: {
        200: {
            content: {
                application/json: {
                    purchaseOrderTypes?: null | ({
                        code?: null | string;
                        name?: null | string;
                    } & Record<string, never>)[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  purchaseOrderTypes?: null | ({
                      code?: null | string;
                      name?: null | string;
                  } & Record<string, never>)[];
              };
          };
      }
      • content: {
            application/json: {
                purchaseOrderTypes?: null | ({
                    code?: null | string;
                    name?: null | string;
                } & Record<string, never>)[];
            };
        }
        • application/json: {
              purchaseOrderTypes?: null | ({
                  code?: null | string;
                  name?: null | string;
              } & Record<string, never>)[];
          }
          • Optional purchaseOrderTypes?: null | ({
                code?: null | string;
                name?: null | string;
            } & Record<string, never>)[]
PurchaseOrders_PatchAdvisedDate: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advisedDate?: null | string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: number;
                };
            };
        };
    };
}

Update the advisedDate on purchase order.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        Purchase orders ID

  • requestBody: {
        content: {
            application/json: {
                advisedDate?: null | string;
            };
        };
    }

    Description

    Object containing the advised date

    • content: {
          application/json: {
              advisedDate?: null | string;
          };
      }
      • application/json: {
            advisedDate?: null | string;
        }
        • Optional advisedDate?: null | string

          Format: date-time

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  purchaseOrderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                purchaseOrderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              purchaseOrderId?: number;
          }
          • Optional message?: null | string
          • Optional purchaseOrderId?: number

            Format: int32

PurchaseOrders_PatchFreeBool1: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                freeBool1: boolean;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: number;
                };
            };
        };
    };
}

Update FreeBool1 on purchase order.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        Purchase orders ID

  • requestBody: {
        content: {
            application/json: {
                freeBool1: boolean;
            };
        };
    }

    Description

    Object containing FreeBool1

    • content: {
          application/json: {
              freeBool1: boolean;
          };
      }
      • application/json: {
            freeBool1: boolean;
        }
        • freeBool1: boolean
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  purchaseOrderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                purchaseOrderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              purchaseOrderId?: number;
          }
          • Optional message?: null | string
          • Optional purchaseOrderId?: number

            Format: int32

PurchaseOrders_PatchInDate: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                inDate?: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: number;
                };
            };
        };
    };
}

Update the indate on purchase order.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        Purchase orders ID

  • requestBody: {
        content: {
            application/json: {
                inDate?: string;
            };
        };
    }

    Description

    Object containing the indate

    • content: {
          application/json: {
              inDate?: string;
          };
      }
      • application/json: {
            inDate?: string;
        }
        • Optional inDate?: string

          Format: date-time

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  purchaseOrderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                purchaseOrderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              purchaseOrderId?: number;
          }
          • Optional message?: null | string
          • Optional purchaseOrderId?: number

            Format: int32

PurchaseOrders_PatchReportedNumberOfItems: {
    parameters: {
        path: {
            purchaseOrderId: number;
            purchaseOrderLineId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                reportedNumberOfItems: number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/octet-stream: string;
            };
        };
    };
}

Update the reported number of items on a particular purchase order line.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
            purchaseOrderLineId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
          purchaseOrderLineId: number;
      }
      • purchaseOrderId: number
      • purchaseOrderLineId: number

        Description

        Ongoing WMS internal ID of the purchase order line

  • requestBody: {
        content: {
            application/json: {
                reportedNumberOfItems: number;
            };
        };
    }

    Description

    Object containing the reported number of items

    • content: {
          application/json: {
              reportedNumberOfItems: number;
          };
      }
      • application/json: {
            reportedNumberOfItems: number;
        }
        • reportedNumberOfItems: number

          Format: decimal

  • responses: {
        200: {
            content: {
                application/octet-stream: string;
            };
        };
    }
    • 200: {
          content: {
              application/octet-stream: string;
          };
      }
      • content: {
            application/octet-stream: string;
        }
        • application/octet-stream: string
PurchaseOrders_PatchSetReportedNumberOfItemsToReceivedNumberOfItems: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/octet-stream: string;
            };
        };
    };
}

Sets the reported number of items on each purchase order line to the received number of items.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number
  • responses: {
        200: {
            content: {
                application/octet-stream: string;
            };
        };
    }
    • 200: {
          content: {
              application/octet-stream: string;
          };
      }
      • content: {
            application/octet-stream: string;
        }
        • application/octet-stream: string
PurchaseOrders_PatchStatus: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                purchaseOrderStatusNumber: number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: number;
                };
            };
        };
    };
}

Update the status of a purchase order. Note that if the warehouse has started to recieve goods from the purchase order, then it's possible that this call will fail.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        PurchaseOrderId.

  • requestBody: {
        content: {
            application/json: {
                purchaseOrderStatusNumber: number;
            };
        };
    }

    Description

    Object containing the new purchase order status.

    • content: {
          application/json: {
              purchaseOrderStatusNumber: number;
          };
      }
      • application/json: {
            purchaseOrderStatusNumber: number;
        }
        • purchaseOrderStatusNumber: number

          Format: int32

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  purchaseOrderId?: number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                purchaseOrderId?: number;
            };
        }
        • application/json: {
              message?: null | string;
              purchaseOrderId?: number;
          }
          • Optional message?: null | string
          • Optional purchaseOrderId?: number

            Format: int32

PurchaseOrders_PostPurchaseOrderFile: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Create a new file and attach it to a purchase order.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        Purchase order ID.

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    }

    Description

    File object, containing all file data.

    • content: {
          application/json: {
              advanced?: {
                  printingInfo?: {
                      printAsUser?: {
                          userId?: null | number;
                      };
                      printAsWorkstation?: {
                          workstationId?: null | number;
                      };
                      reportId?: null | number;
                  };
              };
              fileDataBase64: string;
              fileName: string;
              mimeType: string;
          };
      }
      • application/json: {
            advanced?: {
                printingInfo?: {
                    printAsUser?: {
                        userId?: null | number;
                    };
                    printAsWorkstation?: {
                        workstationId?: null | number;
                    };
                    reportId?: null | number;
                };
            };
            fileDataBase64: string;
            fileName: string;
            mimeType: string;
        }
        • Optional advanced?: {
              printingInfo?: {
                  printAsUser?: {
                      userId?: null | number;
                  };
                  printAsWorkstation?: {
                      workstationId?: null | number;
                  };
                  reportId?: null | number;
              };
          }
          • Optional printingInfo?: {
                printAsUser?: {
                    userId?: null | number;
                };
                printAsWorkstation?: {
                    workstationId?: null | number;
                };
                reportId?: null | number;
            }
            • Optional printAsUser?: {
                  userId?: null | number;
              }
              • Optional userId?: null | number

                Format: int32

            • Optional printAsWorkstation?: {
                  workstationId?: null | number;
              }
              • Optional workstationId?: null | number

                Format: int32

            • Optional reportId?: null | number

              Format: int32

        • fileDataBase64: string
        • fileName: string
        • mimeType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
PurchaseOrders_Put: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    advisedDate?: null | string;
                    container?: null | string;
                    orderDate?: null | string;
                    purchaseOrderIsReturnType?: null | boolean;
                    purchaseOrderStatusCreated?: null | number;
                };
                customsInfo?: {
                    termsOfDeliveryType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    termsOfDeliveryTypeLocation?: null | string;
                };
                freeValues?: {
                    freeBoolean1?: null | boolean;
                    freeBoolean2?: null | boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeText1?: null | string;
                    freeText2?: null | string;
                    freeText3?: null | string;
                    freeText4?: null | string;
                    freeText5?: null | string;
                };
                goodsOwnerId: number;
                goodsOwnerReference?: null | string;
                inDate?: null | string;
                purchaseOrderLines?: null | {
                    articleItemStatusId?: null | number;
                    articleNumber: string;
                    batchNumber?: null | string;
                    comment?: null | string;
                    currencyCode?: null | string;
                    expiryDate?: null | string;
                    externalOrderLineId?: null | string;
                    inDate?: null | string;
                    lineFreeValues?: {
                        freeDecimal1?: null | number;
                        freeText1?: null | string;
                        freeText2?: null | string;
                    };
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    numberOfItems?: number;
                    productionDate?: null | string;
                    rowNumber: string;
                    rowPrice?: null | number;
                    serialNumber?: null | string;
                }[];
                purchaseOrderNumber: string;
                purchaseOrderRemark?: null | string;
                purchaseOrderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                referenceNumber?: null | string;
                sellerInfo?: {
                    sellerAddress?: {
                        address?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        email?: null | string;
                        isVisible?: null | boolean;
                        mobilePhone?: null | string;
                        name?: null | string;
                        notifyByEmail?: null | boolean;
                        notifyBySMS?: null | boolean;
                        notifyByTelephone?: null | boolean;
                        postCode?: null | string;
                        remark?: null | string;
                        telePhone?: null | string;
                    };
                    sellerName?: null | string;
                    sellerNumber?: null | string;
                };
                supplierInfo?: {
                    supplierAddress?: {
                        address?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        email?: null | string;
                        isVisible?: null | boolean;
                        mobilePhone?: null | string;
                        name?: null | string;
                        notifyByEmail?: null | boolean;
                        notifyBySMS?: null | boolean;
                        notifyByTelephone?: null | boolean;
                        postCode?: null | string;
                        remark?: null | string;
                        telePhone?: null | string;
                    };
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                supplierOrderNumber?: null | string;
                warehouseId?: null | number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: null | number;
                };
            };
        };
    };
}

Update a purchase order.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        Purchase order ID.

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    advisedDate?: null | string;
                    container?: null | string;
                    orderDate?: null | string;
                    purchaseOrderIsReturnType?: null | boolean;
                    purchaseOrderStatusCreated?: null | number;
                };
                customsInfo?: {
                    termsOfDeliveryType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    termsOfDeliveryTypeLocation?: null | string;
                };
                freeValues?: {
                    freeBoolean1?: null | boolean;
                    freeBoolean2?: null | boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeText1?: null | string;
                    freeText2?: null | string;
                    freeText3?: null | string;
                    freeText4?: null | string;
                    freeText5?: null | string;
                };
                goodsOwnerId: number;
                goodsOwnerReference?: null | string;
                inDate?: null | string;
                purchaseOrderLines?: null | {
                    articleItemStatusId?: null | number;
                    articleNumber: string;
                    batchNumber?: null | string;
                    comment?: null | string;
                    currencyCode?: null | string;
                    expiryDate?: null | string;
                    externalOrderLineId?: null | string;
                    inDate?: null | string;
                    lineFreeValues?: {
                        freeDecimal1?: null | number;
                        freeText1?: null | string;
                        freeText2?: null | string;
                    };
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    numberOfItems?: number;
                    productionDate?: null | string;
                    rowNumber: string;
                    rowPrice?: null | number;
                    serialNumber?: null | string;
                }[];
                purchaseOrderNumber: string;
                purchaseOrderRemark?: null | string;
                purchaseOrderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                referenceNumber?: null | string;
                sellerInfo?: {
                    sellerAddress?: {
                        address?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        email?: null | string;
                        isVisible?: null | boolean;
                        mobilePhone?: null | string;
                        name?: null | string;
                        notifyByEmail?: null | boolean;
                        notifyBySMS?: null | boolean;
                        notifyByTelephone?: null | boolean;
                        postCode?: null | string;
                        remark?: null | string;
                        telePhone?: null | string;
                    };
                    sellerName?: null | string;
                    sellerNumber?: null | string;
                };
                supplierInfo?: {
                    supplierAddress?: {
                        address?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        email?: null | string;
                        isVisible?: null | boolean;
                        mobilePhone?: null | string;
                        name?: null | string;
                        notifyByEmail?: null | boolean;
                        notifyBySMS?: null | boolean;
                        notifyByTelephone?: null | boolean;
                        postCode?: null | string;
                        remark?: null | string;
                        telePhone?: null | string;
                    };
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                supplierOrderNumber?: null | string;
                warehouseId?: null | number;
            };
        };
    }

    Description

    Purchase order object, containing all purchase order data.

    • content: {
          application/json: {
              advanced?: {
                  advisedDate?: null | string;
                  container?: null | string;
                  orderDate?: null | string;
                  purchaseOrderIsReturnType?: null | boolean;
                  purchaseOrderStatusCreated?: null | number;
              };
              customsInfo?: {
                  termsOfDeliveryType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  termsOfDeliveryTypeLocation?: null | string;
              };
              freeValues?: {
                  freeBoolean1?: null | boolean;
                  freeBoolean2?: null | boolean;
                  freeDecimal1?: null | number;
                  freeDecimal2?: null | number;
                  freeText1?: null | string;
                  freeText2?: null | string;
                  freeText3?: null | string;
                  freeText4?: null | string;
                  freeText5?: null | string;
              };
              goodsOwnerId: number;
              goodsOwnerReference?: null | string;
              inDate?: null | string;
              purchaseOrderLines?: null | {
                  articleItemStatusId?: null | number;
                  articleNumber: string;
                  batchNumber?: null | string;
                  comment?: null | string;
                  currencyCode?: null | string;
                  expiryDate?: null | string;
                  externalOrderLineId?: null | string;
                  inDate?: null | string;
                  lineFreeValues?: {
                      freeDecimal1?: null | number;
                      freeText1?: null | string;
                      freeText2?: null | string;
                  };
                  lineType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  numberOfItems?: number;
                  productionDate?: null | string;
                  rowNumber: string;
                  rowPrice?: null | number;
                  serialNumber?: null | string;
              }[];
              purchaseOrderNumber: string;
              purchaseOrderRemark?: null | string;
              purchaseOrderType?: {
                  code?: null | string;
                  name?: null | string;
              };
              referenceNumber?: null | string;
              sellerInfo?: {
                  sellerAddress?: {
                      address?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      deliveryInstruction?: null | string;
                      email?: null | string;
                      isVisible?: null | boolean;
                      mobilePhone?: null | string;
                      name?: null | string;
                      notifyByEmail?: null | boolean;
                      notifyBySMS?: null | boolean;
                      notifyByTelephone?: null | boolean;
                      postCode?: null | string;
                      remark?: null | string;
                      telePhone?: null | string;
                  };
                  sellerName?: null | string;
                  sellerNumber?: null | string;
              };
              supplierInfo?: {
                  supplierAddress?: {
                      address?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      deliveryInstruction?: null | string;
                      email?: null | string;
                      isVisible?: null | boolean;
                      mobilePhone?: null | string;
                      name?: null | string;
                      notifyByEmail?: null | boolean;
                      notifyBySMS?: null | boolean;
                      notifyByTelephone?: null | boolean;
                      postCode?: null | string;
                      remark?: null | string;
                      telePhone?: null | string;
                  };
                  supplierName?: null | string;
                  supplierNumber?: null | string;
              };
              supplierOrderNumber?: null | string;
              warehouseId?: null | number;
          };
      }
      • application/json: {
            advanced?: {
                advisedDate?: null | string;
                container?: null | string;
                orderDate?: null | string;
                purchaseOrderIsReturnType?: null | boolean;
                purchaseOrderStatusCreated?: null | number;
            };
            customsInfo?: {
                termsOfDeliveryType?: {
                    code?: null | string;
                    name?: null | string;
                };
                termsOfDeliveryTypeLocation?: null | string;
            };
            freeValues?: {
                freeBoolean1?: null | boolean;
                freeBoolean2?: null | boolean;
                freeDecimal1?: null | number;
                freeDecimal2?: null | number;
                freeText1?: null | string;
                freeText2?: null | string;
                freeText3?: null | string;
                freeText4?: null | string;
                freeText5?: null | string;
            };
            goodsOwnerId: number;
            goodsOwnerReference?: null | string;
            inDate?: null | string;
            purchaseOrderLines?: null | {
                articleItemStatusId?: null | number;
                articleNumber: string;
                batchNumber?: null | string;
                comment?: null | string;
                currencyCode?: null | string;
                expiryDate?: null | string;
                externalOrderLineId?: null | string;
                inDate?: null | string;
                lineFreeValues?: {
                    freeDecimal1?: null | number;
                    freeText1?: null | string;
                    freeText2?: null | string;
                };
                lineType?: {
                    code?: null | string;
                    name?: null | string;
                };
                numberOfItems?: number;
                productionDate?: null | string;
                rowNumber: string;
                rowPrice?: null | number;
                serialNumber?: null | string;
            }[];
            purchaseOrderNumber: string;
            purchaseOrderRemark?: null | string;
            purchaseOrderType?: {
                code?: null | string;
                name?: null | string;
            };
            referenceNumber?: null | string;
            sellerInfo?: {
                sellerAddress?: {
                    address?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    deliveryInstruction?: null | string;
                    email?: null | string;
                    isVisible?: null | boolean;
                    mobilePhone?: null | string;
                    name?: null | string;
                    notifyByEmail?: null | boolean;
                    notifyBySMS?: null | boolean;
                    notifyByTelephone?: null | boolean;
                    postCode?: null | string;
                    remark?: null | string;
                    telePhone?: null | string;
                };
                sellerName?: null | string;
                sellerNumber?: null | string;
            };
            supplierInfo?: {
                supplierAddress?: {
                    address?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    deliveryInstruction?: null | string;
                    email?: null | string;
                    isVisible?: null | boolean;
                    mobilePhone?: null | string;
                    name?: null | string;
                    notifyByEmail?: null | boolean;
                    notifyBySMS?: null | boolean;
                    notifyByTelephone?: null | boolean;
                    postCode?: null | string;
                    remark?: null | string;
                    telePhone?: null | string;
                };
                supplierName?: null | string;
                supplierNumber?: null | string;
            };
            supplierOrderNumber?: null | string;
            warehouseId?: null | number;
        }
        • Optional advanced?: {
              advisedDate?: null | string;
              container?: null | string;
              orderDate?: null | string;
              purchaseOrderIsReturnType?: null | boolean;
              purchaseOrderStatusCreated?: null | number;
          }
          • Optional advisedDate?: null | string

            Format: date-time

          • Optional container?: null | string
          • Optional orderDate?: null | string

            Format: date-time

          • Optional purchaseOrderIsReturnType?: null | boolean
          • Optional purchaseOrderStatusCreated?: null | number

            Format: int32

        • Optional customsInfo?: {
              termsOfDeliveryType?: {
                  code?: null | string;
                  name?: null | string;
              };
              termsOfDeliveryTypeLocation?: null | string;
          }
          • Optional termsOfDeliveryType?: {
                code?: null | string;
                name?: null | string;
            }
            • Optional code?: null | string
            • Optional name?: null | string
          • Optional termsOfDeliveryTypeLocation?: null | string
        • Optional freeValues?: {
              freeBoolean1?: null | boolean;
              freeBoolean2?: null | boolean;
              freeDecimal1?: null | number;
              freeDecimal2?: null | number;
              freeText1?: null | string;
              freeText2?: null | string;
              freeText3?: null | string;
              freeText4?: null | string;
              freeText5?: null | string;
          }
          • Optional freeBoolean1?: null | boolean
          • Optional freeBoolean2?: null | boolean
          • Optional freeDecimal1?: null | number

            Format: decimal

          • Optional freeDecimal2?: null | number

            Format: decimal

          • Optional freeText1?: null | string
          • Optional freeText2?: null | string
          • Optional freeText3?: null | string
          • Optional freeText4?: null | string
          • Optional freeText5?: null | string
        • goodsOwnerId: number

          Format: int32

        • Optional goodsOwnerReference?: null | string
        • Optional inDate?: null | string

          Format: date-time

        • Optional purchaseOrderLines?: null | {
              articleItemStatusId?: null | number;
              articleNumber: string;
              batchNumber?: null | string;
              comment?: null | string;
              currencyCode?: null | string;
              expiryDate?: null | string;
              externalOrderLineId?: null | string;
              inDate?: null | string;
              lineFreeValues?: {
                  freeDecimal1?: null | number;
                  freeText1?: null | string;
                  freeText2?: null | string;
              };
              lineType?: {
                  code?: null | string;
                  name?: null | string;
              };
              numberOfItems?: number;
              productionDate?: null | string;
              rowNumber: string;
              rowPrice?: null | number;
              serialNumber?: null | string;
          }[]
        • purchaseOrderNumber: string
        • Optional purchaseOrderRemark?: null | string
        • Optional purchaseOrderType?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional referenceNumber?: null | string
        • Optional sellerInfo?: {
              sellerAddress?: {
                  address?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  deliveryInstruction?: null | string;
                  email?: null | string;
                  isVisible?: null | boolean;
                  mobilePhone?: null | string;
                  name?: null | string;
                  notifyByEmail?: null | boolean;
                  notifyBySMS?: null | boolean;
                  notifyByTelephone?: null | boolean;
                  postCode?: null | string;
                  remark?: null | string;
                  telePhone?: null | string;
              };
              sellerName?: null | string;
              sellerNumber?: null | string;
          }
          • Optional sellerAddress?: {
                address?: null | string;
                address2?: null | string;
                address3?: null | string;
                city?: null | string;
                countryCode?: null | string;
                countryStateCode?: null | string;
                deliveryInstruction?: null | string;
                email?: null | string;
                isVisible?: null | boolean;
                mobilePhone?: null | string;
                name?: null | string;
                notifyByEmail?: null | boolean;
                notifyBySMS?: null | boolean;
                notifyByTelephone?: null | boolean;
                postCode?: null | string;
                remark?: null | string;
                telePhone?: null | string;
            }
            • Optional address?: null | string
            • Optional address2?: null | string
            • Optional address3?: null | string
            • Optional city?: null | string
            • Optional countryCode?: null | string
            • Optional countryStateCode?: null | string
            • Optional deliveryInstruction?: null | string
            • Optional email?: null | string
            • Optional isVisible?: null | boolean
            • Optional mobilePhone?: null | string
            • Optional name?: null | string
            • Optional notifyByEmail?: null | boolean
            • Optional notifyBySMS?: null | boolean
            • Optional notifyByTelephone?: null | boolean
            • Optional postCode?: null | string
            • Optional remark?: null | string
            • Optional telePhone?: null | string
          • Optional sellerName?: null | string
          • Optional sellerNumber?: null | string
        • Optional supplierInfo?: {
              supplierAddress?: {
                  address?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  deliveryInstruction?: null | string;
                  email?: null | string;
                  isVisible?: null | boolean;
                  mobilePhone?: null | string;
                  name?: null | string;
                  notifyByEmail?: null | boolean;
                  notifyBySMS?: null | boolean;
                  notifyByTelephone?: null | boolean;
                  postCode?: null | string;
                  remark?: null | string;
                  telePhone?: null | string;
              };
              supplierName?: null | string;
              supplierNumber?: null | string;
          }
          • Optional supplierAddress?: {
                address?: null | string;
                address2?: null | string;
                address3?: null | string;
                city?: null | string;
                countryCode?: null | string;
                countryStateCode?: null | string;
                deliveryInstruction?: null | string;
                email?: null | string;
                isVisible?: null | boolean;
                mobilePhone?: null | string;
                name?: null | string;
                notifyByEmail?: null | boolean;
                notifyBySMS?: null | boolean;
                notifyByTelephone?: null | boolean;
                postCode?: null | string;
                remark?: null | string;
                telePhone?: null | string;
            }
            • Optional address?: null | string
            • Optional address2?: null | string
            • Optional address3?: null | string
            • Optional city?: null | string
            • Optional countryCode?: null | string
            • Optional countryStateCode?: null | string
            • Optional deliveryInstruction?: null | string
            • Optional email?: null | string
            • Optional isVisible?: null | boolean
            • Optional mobilePhone?: null | string
            • Optional name?: null | string
            • Optional notifyByEmail?: null | boolean
            • Optional notifyBySMS?: null | boolean
            • Optional notifyByTelephone?: null | boolean
            • Optional postCode?: null | string
            • Optional remark?: null | string
            • Optional telePhone?: null | string
          • Optional supplierName?: null | string
          • Optional supplierNumber?: null | string
        • Optional supplierOrderNumber?: null | string
        • Optional warehouseId?: null | number

          Format: int32

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  purchaseOrderId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                purchaseOrderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              purchaseOrderId?: null | number;
          }
          • Optional message?: null | string
          • Optional purchaseOrderId?: null | number

            Format: int32

PurchaseOrders_Put2: {
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    advisedDate?: null | string;
                    container?: null | string;
                    orderDate?: null | string;
                    purchaseOrderIsReturnType?: null | boolean;
                    purchaseOrderStatusCreated?: null | number;
                };
                customsInfo?: {
                    termsOfDeliveryType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    termsOfDeliveryTypeLocation?: null | string;
                };
                freeValues?: {
                    freeBoolean1?: null | boolean;
                    freeBoolean2?: null | boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeText1?: null | string;
                    freeText2?: null | string;
                    freeText3?: null | string;
                    freeText4?: null | string;
                    freeText5?: null | string;
                };
                goodsOwnerId: number;
                goodsOwnerReference?: null | string;
                inDate?: null | string;
                purchaseOrderLines?: null | {
                    articleItemStatusId?: null | number;
                    articleNumber: string;
                    batchNumber?: null | string;
                    comment?: null | string;
                    currencyCode?: null | string;
                    expiryDate?: null | string;
                    externalOrderLineId?: null | string;
                    inDate?: null | string;
                    lineFreeValues?: {
                        freeDecimal1?: null | number;
                        freeText1?: null | string;
                        freeText2?: null | string;
                    };
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    numberOfItems?: number;
                    productionDate?: null | string;
                    rowNumber: string;
                    rowPrice?: null | number;
                    serialNumber?: null | string;
                }[];
                purchaseOrderNumber: string;
                purchaseOrderRemark?: null | string;
                purchaseOrderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                referenceNumber?: null | string;
                sellerInfo?: {
                    sellerAddress?: {
                        address?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        email?: null | string;
                        isVisible?: null | boolean;
                        mobilePhone?: null | string;
                        name?: null | string;
                        notifyByEmail?: null | boolean;
                        notifyBySMS?: null | boolean;
                        notifyByTelephone?: null | boolean;
                        postCode?: null | string;
                        remark?: null | string;
                        telePhone?: null | string;
                    };
                    sellerName?: null | string;
                    sellerNumber?: null | string;
                };
                supplierInfo?: {
                    supplierAddress?: {
                        address?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        email?: null | string;
                        isVisible?: null | boolean;
                        mobilePhone?: null | string;
                        name?: null | string;
                        notifyByEmail?: null | boolean;
                        notifyBySMS?: null | boolean;
                        notifyByTelephone?: null | boolean;
                        postCode?: null | string;
                        remark?: null | string;
                        telePhone?: null | string;
                    };
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                supplierOrderNumber?: null | string;
                warehouseId?: null | number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: null | number;
                };
            };
        };
    };
}

Create or update a purchase order. If no purchase order with the specified purchase order number exists, a new purchase order will be created. Otherwise the existing purchase order will be updated.

Type declaration

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    advisedDate?: null | string;
                    container?: null | string;
                    orderDate?: null | string;
                    purchaseOrderIsReturnType?: null | boolean;
                    purchaseOrderStatusCreated?: null | number;
                };
                customsInfo?: {
                    termsOfDeliveryType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    termsOfDeliveryTypeLocation?: null | string;
                };
                freeValues?: {
                    freeBoolean1?: null | boolean;
                    freeBoolean2?: null | boolean;
                    freeDecimal1?: null | number;
                    freeDecimal2?: null | number;
                    freeText1?: null | string;
                    freeText2?: null | string;
                    freeText3?: null | string;
                    freeText4?: null | string;
                    freeText5?: null | string;
                };
                goodsOwnerId: number;
                goodsOwnerReference?: null | string;
                inDate?: null | string;
                purchaseOrderLines?: null | {
                    articleItemStatusId?: null | number;
                    articleNumber: string;
                    batchNumber?: null | string;
                    comment?: null | string;
                    currencyCode?: null | string;
                    expiryDate?: null | string;
                    externalOrderLineId?: null | string;
                    inDate?: null | string;
                    lineFreeValues?: {
                        freeDecimal1?: null | number;
                        freeText1?: null | string;
                        freeText2?: null | string;
                    };
                    lineType?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    numberOfItems?: number;
                    productionDate?: null | string;
                    rowNumber: string;
                    rowPrice?: null | number;
                    serialNumber?: null | string;
                }[];
                purchaseOrderNumber: string;
                purchaseOrderRemark?: null | string;
                purchaseOrderType?: {
                    code?: null | string;
                    name?: null | string;
                };
                referenceNumber?: null | string;
                sellerInfo?: {
                    sellerAddress?: {
                        address?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        email?: null | string;
                        isVisible?: null | boolean;
                        mobilePhone?: null | string;
                        name?: null | string;
                        notifyByEmail?: null | boolean;
                        notifyBySMS?: null | boolean;
                        notifyByTelephone?: null | boolean;
                        postCode?: null | string;
                        remark?: null | string;
                        telePhone?: null | string;
                    };
                    sellerName?: null | string;
                    sellerNumber?: null | string;
                };
                supplierInfo?: {
                    supplierAddress?: {
                        address?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        email?: null | string;
                        isVisible?: null | boolean;
                        mobilePhone?: null | string;
                        name?: null | string;
                        notifyByEmail?: null | boolean;
                        notifyBySMS?: null | boolean;
                        notifyByTelephone?: null | boolean;
                        postCode?: null | string;
                        remark?: null | string;
                        telePhone?: null | string;
                    };
                    supplierName?: null | string;
                    supplierNumber?: null | string;
                };
                supplierOrderNumber?: null | string;
                warehouseId?: null | number;
            };
        };
    }

    Description

    Purchase order object, containing all purchase order data.

    • content: {
          application/json: {
              advanced?: {
                  advisedDate?: null | string;
                  container?: null | string;
                  orderDate?: null | string;
                  purchaseOrderIsReturnType?: null | boolean;
                  purchaseOrderStatusCreated?: null | number;
              };
              customsInfo?: {
                  termsOfDeliveryType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  termsOfDeliveryTypeLocation?: null | string;
              };
              freeValues?: {
                  freeBoolean1?: null | boolean;
                  freeBoolean2?: null | boolean;
                  freeDecimal1?: null | number;
                  freeDecimal2?: null | number;
                  freeText1?: null | string;
                  freeText2?: null | string;
                  freeText3?: null | string;
                  freeText4?: null | string;
                  freeText5?: null | string;
              };
              goodsOwnerId: number;
              goodsOwnerReference?: null | string;
              inDate?: null | string;
              purchaseOrderLines?: null | {
                  articleItemStatusId?: null | number;
                  articleNumber: string;
                  batchNumber?: null | string;
                  comment?: null | string;
                  currencyCode?: null | string;
                  expiryDate?: null | string;
                  externalOrderLineId?: null | string;
                  inDate?: null | string;
                  lineFreeValues?: {
                      freeDecimal1?: null | number;
                      freeText1?: null | string;
                      freeText2?: null | string;
                  };
                  lineType?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  numberOfItems?: number;
                  productionDate?: null | string;
                  rowNumber: string;
                  rowPrice?: null | number;
                  serialNumber?: null | string;
              }[];
              purchaseOrderNumber: string;
              purchaseOrderRemark?: null | string;
              purchaseOrderType?: {
                  code?: null | string;
                  name?: null | string;
              };
              referenceNumber?: null | string;
              sellerInfo?: {
                  sellerAddress?: {
                      address?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      deliveryInstruction?: null | string;
                      email?: null | string;
                      isVisible?: null | boolean;
                      mobilePhone?: null | string;
                      name?: null | string;
                      notifyByEmail?: null | boolean;
                      notifyBySMS?: null | boolean;
                      notifyByTelephone?: null | boolean;
                      postCode?: null | string;
                      remark?: null | string;
                      telePhone?: null | string;
                  };
                  sellerName?: null | string;
                  sellerNumber?: null | string;
              };
              supplierInfo?: {
                  supplierAddress?: {
                      address?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      deliveryInstruction?: null | string;
                      email?: null | string;
                      isVisible?: null | boolean;
                      mobilePhone?: null | string;
                      name?: null | string;
                      notifyByEmail?: null | boolean;
                      notifyBySMS?: null | boolean;
                      notifyByTelephone?: null | boolean;
                      postCode?: null | string;
                      remark?: null | string;
                      telePhone?: null | string;
                  };
                  supplierName?: null | string;
                  supplierNumber?: null | string;
              };
              supplierOrderNumber?: null | string;
              warehouseId?: null | number;
          };
      }
      • application/json: {
            advanced?: {
                advisedDate?: null | string;
                container?: null | string;
                orderDate?: null | string;
                purchaseOrderIsReturnType?: null | boolean;
                purchaseOrderStatusCreated?: null | number;
            };
            customsInfo?: {
                termsOfDeliveryType?: {
                    code?: null | string;
                    name?: null | string;
                };
                termsOfDeliveryTypeLocation?: null | string;
            };
            freeValues?: {
                freeBoolean1?: null | boolean;
                freeBoolean2?: null | boolean;
                freeDecimal1?: null | number;
                freeDecimal2?: null | number;
                freeText1?: null | string;
                freeText2?: null | string;
                freeText3?: null | string;
                freeText4?: null | string;
                freeText5?: null | string;
            };
            goodsOwnerId: number;
            goodsOwnerReference?: null | string;
            inDate?: null | string;
            purchaseOrderLines?: null | {
                articleItemStatusId?: null | number;
                articleNumber: string;
                batchNumber?: null | string;
                comment?: null | string;
                currencyCode?: null | string;
                expiryDate?: null | string;
                externalOrderLineId?: null | string;
                inDate?: null | string;
                lineFreeValues?: {
                    freeDecimal1?: null | number;
                    freeText1?: null | string;
                    freeText2?: null | string;
                };
                lineType?: {
                    code?: null | string;
                    name?: null | string;
                };
                numberOfItems?: number;
                productionDate?: null | string;
                rowNumber: string;
                rowPrice?: null | number;
                serialNumber?: null | string;
            }[];
            purchaseOrderNumber: string;
            purchaseOrderRemark?: null | string;
            purchaseOrderType?: {
                code?: null | string;
                name?: null | string;
            };
            referenceNumber?: null | string;
            sellerInfo?: {
                sellerAddress?: {
                    address?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    deliveryInstruction?: null | string;
                    email?: null | string;
                    isVisible?: null | boolean;
                    mobilePhone?: null | string;
                    name?: null | string;
                    notifyByEmail?: null | boolean;
                    notifyBySMS?: null | boolean;
                    notifyByTelephone?: null | boolean;
                    postCode?: null | string;
                    remark?: null | string;
                    telePhone?: null | string;
                };
                sellerName?: null | string;
                sellerNumber?: null | string;
            };
            supplierInfo?: {
                supplierAddress?: {
                    address?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    deliveryInstruction?: null | string;
                    email?: null | string;
                    isVisible?: null | boolean;
                    mobilePhone?: null | string;
                    name?: null | string;
                    notifyByEmail?: null | boolean;
                    notifyBySMS?: null | boolean;
                    notifyByTelephone?: null | boolean;
                    postCode?: null | string;
                    remark?: null | string;
                    telePhone?: null | string;
                };
                supplierName?: null | string;
                supplierNumber?: null | string;
            };
            supplierOrderNumber?: null | string;
            warehouseId?: null | number;
        }
        • Optional advanced?: {
              advisedDate?: null | string;
              container?: null | string;
              orderDate?: null | string;
              purchaseOrderIsReturnType?: null | boolean;
              purchaseOrderStatusCreated?: null | number;
          }
          • Optional advisedDate?: null | string

            Format: date-time

          • Optional container?: null | string
          • Optional orderDate?: null | string

            Format: date-time

          • Optional purchaseOrderIsReturnType?: null | boolean
          • Optional purchaseOrderStatusCreated?: null | number

            Format: int32

        • Optional customsInfo?: {
              termsOfDeliveryType?: {
                  code?: null | string;
                  name?: null | string;
              };
              termsOfDeliveryTypeLocation?: null | string;
          }
          • Optional termsOfDeliveryType?: {
                code?: null | string;
                name?: null | string;
            }
            • Optional code?: null | string
            • Optional name?: null | string
          • Optional termsOfDeliveryTypeLocation?: null | string
        • Optional freeValues?: {
              freeBoolean1?: null | boolean;
              freeBoolean2?: null | boolean;
              freeDecimal1?: null | number;
              freeDecimal2?: null | number;
              freeText1?: null | string;
              freeText2?: null | string;
              freeText3?: null | string;
              freeText4?: null | string;
              freeText5?: null | string;
          }
          • Optional freeBoolean1?: null | boolean
          • Optional freeBoolean2?: null | boolean
          • Optional freeDecimal1?: null | number

            Format: decimal

          • Optional freeDecimal2?: null | number

            Format: decimal

          • Optional freeText1?: null | string
          • Optional freeText2?: null | string
          • Optional freeText3?: null | string
          • Optional freeText4?: null | string
          • Optional freeText5?: null | string
        • goodsOwnerId: number

          Format: int32

        • Optional goodsOwnerReference?: null | string
        • Optional inDate?: null | string

          Format: date-time

        • Optional purchaseOrderLines?: null | {
              articleItemStatusId?: null | number;
              articleNumber: string;
              batchNumber?: null | string;
              comment?: null | string;
              currencyCode?: null | string;
              expiryDate?: null | string;
              externalOrderLineId?: null | string;
              inDate?: null | string;
              lineFreeValues?: {
                  freeDecimal1?: null | number;
                  freeText1?: null | string;
                  freeText2?: null | string;
              };
              lineType?: {
                  code?: null | string;
                  name?: null | string;
              };
              numberOfItems?: number;
              productionDate?: null | string;
              rowNumber: string;
              rowPrice?: null | number;
              serialNumber?: null | string;
          }[]
        • purchaseOrderNumber: string
        • Optional purchaseOrderRemark?: null | string
        • Optional purchaseOrderType?: {
              code?: null | string;
              name?: null | string;
          }
          • Optional code?: null | string
          • Optional name?: null | string
        • Optional referenceNumber?: null | string
        • Optional sellerInfo?: {
              sellerAddress?: {
                  address?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  deliveryInstruction?: null | string;
                  email?: null | string;
                  isVisible?: null | boolean;
                  mobilePhone?: null | string;
                  name?: null | string;
                  notifyByEmail?: null | boolean;
                  notifyBySMS?: null | boolean;
                  notifyByTelephone?: null | boolean;
                  postCode?: null | string;
                  remark?: null | string;
                  telePhone?: null | string;
              };
              sellerName?: null | string;
              sellerNumber?: null | string;
          }
          • Optional sellerAddress?: {
                address?: null | string;
                address2?: null | string;
                address3?: null | string;
                city?: null | string;
                countryCode?: null | string;
                countryStateCode?: null | string;
                deliveryInstruction?: null | string;
                email?: null | string;
                isVisible?: null | boolean;
                mobilePhone?: null | string;
                name?: null | string;
                notifyByEmail?: null | boolean;
                notifyBySMS?: null | boolean;
                notifyByTelephone?: null | boolean;
                postCode?: null | string;
                remark?: null | string;
                telePhone?: null | string;
            }
            • Optional address?: null | string
            • Optional address2?: null | string
            • Optional address3?: null | string
            • Optional city?: null | string
            • Optional countryCode?: null | string
            • Optional countryStateCode?: null | string
            • Optional deliveryInstruction?: null | string
            • Optional email?: null | string
            • Optional isVisible?: null | boolean
            • Optional mobilePhone?: null | string
            • Optional name?: null | string
            • Optional notifyByEmail?: null | boolean
            • Optional notifyBySMS?: null | boolean
            • Optional notifyByTelephone?: null | boolean
            • Optional postCode?: null | string
            • Optional remark?: null | string
            • Optional telePhone?: null | string
          • Optional sellerName?: null | string
          • Optional sellerNumber?: null | string
        • Optional supplierInfo?: {
              supplierAddress?: {
                  address?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  deliveryInstruction?: null | string;
                  email?: null | string;
                  isVisible?: null | boolean;
                  mobilePhone?: null | string;
                  name?: null | string;
                  notifyByEmail?: null | boolean;
                  notifyBySMS?: null | boolean;
                  notifyByTelephone?: null | boolean;
                  postCode?: null | string;
                  remark?: null | string;
                  telePhone?: null | string;
              };
              supplierName?: null | string;
              supplierNumber?: null | string;
          }
          • Optional supplierAddress?: {
                address?: null | string;
                address2?: null | string;
                address3?: null | string;
                city?: null | string;
                countryCode?: null | string;
                countryStateCode?: null | string;
                deliveryInstruction?: null | string;
                email?: null | string;
                isVisible?: null | boolean;
                mobilePhone?: null | string;
                name?: null | string;
                notifyByEmail?: null | boolean;
                notifyBySMS?: null | boolean;
                notifyByTelephone?: null | boolean;
                postCode?: null | string;
                remark?: null | string;
                telePhone?: null | string;
            }
            • Optional address?: null | string
            • Optional address2?: null | string
            • Optional address3?: null | string
            • Optional city?: null | string
            • Optional countryCode?: null | string
            • Optional countryStateCode?: null | string
            • Optional deliveryInstruction?: null | string
            • Optional email?: null | string
            • Optional isVisible?: null | boolean
            • Optional mobilePhone?: null | string
            • Optional name?: null | string
            • Optional notifyByEmail?: null | boolean
            • Optional notifyBySMS?: null | boolean
            • Optional notifyByTelephone?: null | boolean
            • Optional postCode?: null | string
            • Optional remark?: null | string
            • Optional telePhone?: null | string
          • Optional supplierName?: null | string
          • Optional supplierNumber?: null | string
        • Optional supplierOrderNumber?: null | string
        • Optional warehouseId?: null | number

          Format: int32

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    purchaseOrderId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  purchaseOrderId?: null | number;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                purchaseOrderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              purchaseOrderId?: null | number;
          }
          • Optional message?: null | string
          • Optional purchaseOrderId?: null | number

            Format: int32

PurchaseOrders_PutArticleItems: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                items?: null | {
                    batch?: null | string;
                    caseNumber?: null | string;
                    comment?: null | string;
                    container?: null | string;
                    expiryDate?: null | string;
                    height?: null | number;
                    length?: null | number;
                    numberOfItems?: null | number;
                    price?: null | number;
                    productionDate?: null | string;
                    purchaseOrderLineId: number;
                    serial?: null | string;
                    statusId?: null | number;
                    volume?: null | number;
                    weight?: null | number;
                    width?: null | number;
                }[];
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    messages?: null | {
                        articleItemId?: null | number;
                        message?: null | string;
                        purchaseOrderLineId?: number;
                        success?: boolean;
                    }[];
                    success?: boolean;
                };
            };
        };
    };
}

Add article items to a purchase order.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        The purchase order ID.

  • requestBody: {
        content: {
            application/json: {
                items?: null | {
                    batch?: null | string;
                    caseNumber?: null | string;
                    comment?: null | string;
                    container?: null | string;
                    expiryDate?: null | string;
                    height?: null | number;
                    length?: null | number;
                    numberOfItems?: null | number;
                    price?: null | number;
                    productionDate?: null | string;
                    purchaseOrderLineId: number;
                    serial?: null | string;
                    statusId?: null | number;
                    volume?: null | number;
                    weight?: null | number;
                    width?: null | number;
                }[];
            };
        };
    }

    Description

    The article items which you want to add.

    • content: {
          application/json: {
              items?: null | {
                  batch?: null | string;
                  caseNumber?: null | string;
                  comment?: null | string;
                  container?: null | string;
                  expiryDate?: null | string;
                  height?: null | number;
                  length?: null | number;
                  numberOfItems?: null | number;
                  price?: null | number;
                  productionDate?: null | string;
                  purchaseOrderLineId: number;
                  serial?: null | string;
                  statusId?: null | number;
                  volume?: null | number;
                  weight?: null | number;
                  width?: null | number;
              }[];
          };
      }
      • application/json: {
            items?: null | {
                batch?: null | string;
                caseNumber?: null | string;
                comment?: null | string;
                container?: null | string;
                expiryDate?: null | string;
                height?: null | number;
                length?: null | number;
                numberOfItems?: null | number;
                price?: null | number;
                productionDate?: null | string;
                purchaseOrderLineId: number;
                serial?: null | string;
                statusId?: null | number;
                volume?: null | number;
                weight?: null | number;
                width?: null | number;
            }[];
        }
        • Optional items?: null | {
              batch?: null | string;
              caseNumber?: null | string;
              comment?: null | string;
              container?: null | string;
              expiryDate?: null | string;
              height?: null | number;
              length?: null | number;
              numberOfItems?: null | number;
              price?: null | number;
              productionDate?: null | string;
              purchaseOrderLineId: number;
              serial?: null | string;
              statusId?: null | number;
              volume?: null | number;
              weight?: null | number;
              width?: null | number;
          }[]
  • responses: {
        200: {
            content: {
                application/json: {
                    messages?: null | {
                        articleItemId?: null | number;
                        message?: null | string;
                        purchaseOrderLineId?: number;
                        success?: boolean;
                    }[];
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  messages?: null | {
                      articleItemId?: null | number;
                      message?: null | string;
                      purchaseOrderLineId?: number;
                      success?: boolean;
                  }[];
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                messages?: null | {
                    articleItemId?: null | number;
                    message?: null | string;
                    purchaseOrderLineId?: number;
                    success?: boolean;
                }[];
                success?: boolean;
            };
        }
        • application/json: {
              messages?: null | {
                  articleItemId?: null | number;
                  message?: null | string;
                  purchaseOrderLineId?: number;
                  success?: boolean;
              }[];
              success?: boolean;
          }
          • Optional messages?: null | {
                articleItemId?: null | number;
                message?: null | string;
                purchaseOrderLineId?: number;
                success?: boolean;
            }[]
          • Optional success?: boolean
PurchaseOrders_PutFile: {
    parameters: {
        path: {
            fileId: number;
            purchaseOrderId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Update a file which is attached to a purchase order.

Type declaration

  • parameters: {
        path: {
            fileId: number;
            purchaseOrderId: number;
        };
    }
    • path: {
          fileId: number;
          purchaseOrderId: number;
      }
      • fileId: number

        Description

        File ID.

      • purchaseOrderId: number

        Description

        Purchase order ID.

  • requestBody: {
        content: {
            application/json: {
                advanced?: {
                    printingInfo?: {
                        printAsUser?: {
                            userId?: null | number;
                        };
                        printAsWorkstation?: {
                            workstationId?: null | number;
                        };
                        reportId?: null | number;
                    };
                };
                fileDataBase64: string;
                fileName: string;
                mimeType: string;
            };
        };
    }

    Description

    File object, containing all file data.

    • content: {
          application/json: {
              advanced?: {
                  printingInfo?: {
                      printAsUser?: {
                          userId?: null | number;
                      };
                      printAsWorkstation?: {
                          workstationId?: null | number;
                      };
                      reportId?: null | number;
                  };
              };
              fileDataBase64: string;
              fileName: string;
              mimeType: string;
          };
      }
      • application/json: {
            advanced?: {
                printingInfo?: {
                    printAsUser?: {
                        userId?: null | number;
                    };
                    printAsWorkstation?: {
                        workstationId?: null | number;
                    };
                    reportId?: null | number;
                };
            };
            fileDataBase64: string;
            fileName: string;
            mimeType: string;
        }
        • Optional advanced?: {
              printingInfo?: {
                  printAsUser?: {
                      userId?: null | number;
                  };
                  printAsWorkstation?: {
                      workstationId?: null | number;
                  };
                  reportId?: null | number;
              };
          }
          • Optional printingInfo?: {
                printAsUser?: {
                    userId?: null | number;
                };
                printAsWorkstation?: {
                    workstationId?: null | number;
                };
                reportId?: null | number;
            }
            • Optional printAsUser?: {
                  userId?: null | number;
              }
              • Optional userId?: null | number

                Format: int32

            • Optional printAsWorkstation?: {
                  workstationId?: null | number;
              }
              • Optional workstationId?: null | number

                Format: int32

            • Optional reportId?: null | number

              Format: int32

        • fileDataBase64: string
        • fileName: string
        • mimeType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
PurchaseOrders_PutFileUsingFilename: {
    parameters: {
        path: {
            purchaseOrderId: number;
        };
        query: {
            fileName: null | string;
        };
    };
    requestBody: {
        content: {
            application/json: {
                fileDataBase64: string;
                mimeType: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    };
}

Create or update a file which is attached to a purchase order. The filename will be used to check if the file already exists.

Type declaration

  • parameters: {
        path: {
            purchaseOrderId: number;
        };
        query: {
            fileName: null | string;
        };
    }
    • path: {
          purchaseOrderId: number;
      }
      • purchaseOrderId: number

        Description

        Purchase order ID.

    • query: {
          fileName: null | string;
      }
      • fileName: null | string

        Description

        File name.

  • requestBody: {
        content: {
            application/json: {
                fileDataBase64: string;
                mimeType: string;
            };
        };
    }

    Description

    File object, containing all file data.

    • content: {
          application/json: {
              fileDataBase64: string;
              mimeType: string;
          };
      }
      • application/json: {
            fileDataBase64: string;
            mimeType: string;
        }
        • fileDataBase64: string
        • mimeType: string
  • responses: {
        200: {
            content: {
                application/json: {
                    fileId?: null | number;
                    message?: null | string;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  fileId?: null | number;
                  message?: null | string;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                fileId?: null | number;
                message?: null | string;
                success?: boolean;
            };
        }
        • application/json: {
              fileId?: null | number;
              message?: null | string;
              success?: boolean;
          }
          • Optional fileId?: null | number

            Format: int32

          • Optional message?: null | string
          • Optional success?: boolean
ReturnOrders_Get: {
    parameters: {
        query: {
            customerOrderNumbers?: null | string[];
            goodsOwnerId: number;
            goodsReturnedFromDate?: null | string;
            returnOrderNumbers?: null | string[];
            returnOrderStatusFrom?: null | number;
            returnOrderStatusTo?: null | number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    customerOrderInfo?: {
                        orderId?: number;
                        orderNumber?: null | string;
                    };
                    returnOrderInfo?: {
                        comment?: null | string;
                        inDate?: null | string;
                        returnOrderHandlingComment?: null | string;
                        returnOrderId?: number;
                        returnOrderNumber?: null | string;
                        returnOrderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    };
                    returnOrderLines?: null | {
                        article?: {
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                        };
                        customerOrderLine?: {
                            customerOrderRowNumber?: null | string;
                            orderLineId?: number;
                        };
                        pickedNumberOfItems?: number;
                        returnCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        returnOrderLineId?: number;
                        returnOrderRowNumber?: null | string;
                        returnedArticleItems?: null | {
                            articleItemCategory?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batch?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            isReturnRemovedByInventory?: boolean;
                            numberOfItems?: number;
                            returnCause?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            returnComment?: null | string;
                            returnTime?: null | string;
                            serial?: null | string;
                            volume?: null | number;
                            weight?: null | number;
                        }[];
                        returnedNumberOfItems?: number;
                        returnedRemovedByInventoryNumberOfItems?: number;
                        toBeReturnedNumberOfItems?: number;
                    }[];
                }[];
            };
        };
    };
}

Get a list of return orders which match the specified search criteria.

Type declaration

  • parameters: {
        query: {
            customerOrderNumbers?: null | string[];
            goodsOwnerId: number;
            goodsReturnedFromDate?: null | string;
            returnOrderNumbers?: null | string[];
            returnOrderStatusFrom?: null | number;
            returnOrderStatusTo?: null | number;
        };
    }
    • query: {
          customerOrderNumbers?: null | string[];
          goodsOwnerId: number;
          goodsReturnedFromDate?: null | string;
          returnOrderNumbers?: null | string[];
          returnOrderStatusFrom?: null | number;
          returnOrderStatusTo?: null | number;
      }
      • Optional customerOrderNumbers?: null | string[]

        Description

        A list of customer order numbers

      • goodsOwnerId: number

        Description

        Goods owner ID

      • Optional goodsReturnedFromDate?: null | string

        Description

        Only return orders where a return has been made after this date.

      • Optional returnOrderNumbers?: null | string[]

        Description

        A list of return order numbers

      • Optional returnOrderStatusFrom?: null | number

        Description

        Only return orders whose return order status is greater than or equal to this.

      • Optional returnOrderStatusTo?: null | number

        Description

        Only return orders whose return order status is less than or equal to this.

  • responses: {
        200: {
            content: {
                application/json: {
                    customerOrderInfo?: {
                        orderId?: number;
                        orderNumber?: null | string;
                    };
                    returnOrderInfo?: {
                        comment?: null | string;
                        inDate?: null | string;
                        returnOrderHandlingComment?: null | string;
                        returnOrderId?: number;
                        returnOrderNumber?: null | string;
                        returnOrderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    };
                    returnOrderLines?: null | {
                        article?: {
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                        };
                        customerOrderLine?: {
                            customerOrderRowNumber?: null | string;
                            orderLineId?: number;
                        };
                        pickedNumberOfItems?: number;
                        returnCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        returnOrderLineId?: number;
                        returnOrderRowNumber?: null | string;
                        returnedArticleItems?: null | {
                            articleItemCategory?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batch?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            isReturnRemovedByInventory?: boolean;
                            numberOfItems?: number;
                            returnCause?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            returnComment?: null | string;
                            returnTime?: null | string;
                            serial?: null | string;
                            volume?: null | number;
                            weight?: null | number;
                        }[];
                        returnedNumberOfItems?: number;
                        returnedRemovedByInventoryNumberOfItems?: number;
                        toBeReturnedNumberOfItems?: number;
                    }[];
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  customerOrderInfo?: {
                      orderId?: number;
                      orderNumber?: null | string;
                  };
                  returnOrderInfo?: {
                      comment?: null | string;
                      inDate?: null | string;
                      returnOrderHandlingComment?: null | string;
                      returnOrderId?: number;
                      returnOrderNumber?: null | string;
                      returnOrderStatus?: {
                          number?: number;
                          text?: null | string;
                      };
                      warehouse?: {
                          code?: null | string;
                          id?: number;
                          name?: null | string;
                      };
                  };
                  returnOrderLines?: null | {
                      article?: {
                          articleName?: null | string;
                          articleNumber?: null | string;
                          articleSystemId?: number;
                      };
                      customerOrderLine?: {
                          customerOrderRowNumber?: null | string;
                          orderLineId?: number;
                      };
                      pickedNumberOfItems?: number;
                      returnCause?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      returnOrderLineId?: number;
                      returnOrderRowNumber?: null | string;
                      returnedArticleItems?: null | {
                          articleItemCategory?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          articleItemStatus?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          batch?: null | string;
                          comment?: null | string;
                          container?: null | string;
                          expiryDate?: null | string;
                          isReturnRemovedByInventory?: boolean;
                          numberOfItems?: number;
                          returnCause?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          returnComment?: null | string;
                          returnTime?: null | string;
                          serial?: null | string;
                          volume?: null | number;
                          weight?: null | number;
                      }[];
                      returnedNumberOfItems?: number;
                      returnedRemovedByInventoryNumberOfItems?: number;
                      toBeReturnedNumberOfItems?: number;
                  }[];
              }[];
          };
      }

      Description

      A list of return orders.

      • content: {
            application/json: {
                customerOrderInfo?: {
                    orderId?: number;
                    orderNumber?: null | string;
                };
                returnOrderInfo?: {
                    comment?: null | string;
                    inDate?: null | string;
                    returnOrderHandlingComment?: null | string;
                    returnOrderId?: number;
                    returnOrderNumber?: null | string;
                    returnOrderStatus?: {
                        number?: number;
                        text?: null | string;
                    };
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                };
                returnOrderLines?: null | {
                    article?: {
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                    };
                    customerOrderLine?: {
                        customerOrderRowNumber?: null | string;
                        orderLineId?: number;
                    };
                    pickedNumberOfItems?: number;
                    returnCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    returnOrderLineId?: number;
                    returnOrderRowNumber?: null | string;
                    returnedArticleItems?: null | {
                        articleItemCategory?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batch?: null | string;
                        comment?: null | string;
                        container?: null | string;
                        expiryDate?: null | string;
                        isReturnRemovedByInventory?: boolean;
                        numberOfItems?: number;
                        returnCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        returnComment?: null | string;
                        returnTime?: null | string;
                        serial?: null | string;
                        volume?: null | number;
                        weight?: null | number;
                    }[];
                    returnedNumberOfItems?: number;
                    returnedRemovedByInventoryNumberOfItems?: number;
                    toBeReturnedNumberOfItems?: number;
                }[];
            }[];
        }
        • application/json: {
              customerOrderInfo?: {
                  orderId?: number;
                  orderNumber?: null | string;
              };
              returnOrderInfo?: {
                  comment?: null | string;
                  inDate?: null | string;
                  returnOrderHandlingComment?: null | string;
                  returnOrderId?: number;
                  returnOrderNumber?: null | string;
                  returnOrderStatus?: {
                      number?: number;
                      text?: null | string;
                  };
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
              };
              returnOrderLines?: null | {
                  article?: {
                      articleName?: null | string;
                      articleNumber?: null | string;
                      articleSystemId?: number;
                  };
                  customerOrderLine?: {
                      customerOrderRowNumber?: null | string;
                      orderLineId?: number;
                  };
                  pickedNumberOfItems?: number;
                  returnCause?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  returnOrderLineId?: number;
                  returnOrderRowNumber?: null | string;
                  returnedArticleItems?: null | {
                      articleItemCategory?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      articleItemStatus?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      batch?: null | string;
                      comment?: null | string;
                      container?: null | string;
                      expiryDate?: null | string;
                      isReturnRemovedByInventory?: boolean;
                      numberOfItems?: number;
                      returnCause?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      returnComment?: null | string;
                      returnTime?: null | string;
                      serial?: null | string;
                      volume?: null | number;
                      weight?: null | number;
                  }[];
                  returnedNumberOfItems?: number;
                  returnedRemovedByInventoryNumberOfItems?: number;
                  toBeReturnedNumberOfItems?: number;
              }[];
          }[]
ReturnOrders_GetByReturnOrderId: {
    parameters: {
        path: {
            returnOrderId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    customerOrderInfo?: {
                        orderId?: number;
                        orderNumber?: null | string;
                    };
                    returnOrderInfo?: {
                        comment?: null | string;
                        inDate?: null | string;
                        returnOrderHandlingComment?: null | string;
                        returnOrderId?: number;
                        returnOrderNumber?: null | string;
                        returnOrderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    };
                    returnOrderLines?: null | {
                        article?: {
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                        };
                        customerOrderLine?: {
                            customerOrderRowNumber?: null | string;
                            orderLineId?: number;
                        };
                        pickedNumberOfItems?: number;
                        returnCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        returnOrderLineId?: number;
                        returnOrderRowNumber?: null | string;
                        returnedArticleItems?: null | {
                            articleItemCategory?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batch?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            isReturnRemovedByInventory?: boolean;
                            numberOfItems?: number;
                            returnCause?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            returnComment?: null | string;
                            returnTime?: null | string;
                            serial?: null | string;
                            volume?: null | number;
                            weight?: null | number;
                        }[];
                        returnedNumberOfItems?: number;
                        returnedRemovedByInventoryNumberOfItems?: number;
                        toBeReturnedNumberOfItems?: number;
                    }[];
                };
            };
        };
    };
}

Get a return order using the return order ID.

Type declaration

  • parameters: {
        path: {
            returnOrderId: number;
        };
    }
    • path: {
          returnOrderId: number;
      }
      • returnOrderId: number

        Description

        Return order ID.

  • responses: {
        200: {
            content: {
                application/json: {
                    customerOrderInfo?: {
                        orderId?: number;
                        orderNumber?: null | string;
                    };
                    returnOrderInfo?: {
                        comment?: null | string;
                        inDate?: null | string;
                        returnOrderHandlingComment?: null | string;
                        returnOrderId?: number;
                        returnOrderNumber?: null | string;
                        returnOrderStatus?: {
                            number?: number;
                            text?: null | string;
                        };
                        warehouse?: {
                            code?: null | string;
                            id?: number;
                            name?: null | string;
                        };
                    };
                    returnOrderLines?: null | {
                        article?: {
                            articleName?: null | string;
                            articleNumber?: null | string;
                            articleSystemId?: number;
                        };
                        customerOrderLine?: {
                            customerOrderRowNumber?: null | string;
                            orderLineId?: number;
                        };
                        pickedNumberOfItems?: number;
                        returnCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        returnOrderLineId?: number;
                        returnOrderRowNumber?: null | string;
                        returnedArticleItems?: null | {
                            articleItemCategory?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            articleItemStatus?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            batch?: null | string;
                            comment?: null | string;
                            container?: null | string;
                            expiryDate?: null | string;
                            isReturnRemovedByInventory?: boolean;
                            numberOfItems?: number;
                            returnCause?: {
                                code?: null | string;
                                name?: null | string;
                            };
                            returnComment?: null | string;
                            returnTime?: null | string;
                            serial?: null | string;
                            volume?: null | number;
                            weight?: null | number;
                        }[];
                        returnedNumberOfItems?: number;
                        returnedRemovedByInventoryNumberOfItems?: number;
                        toBeReturnedNumberOfItems?: number;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  customerOrderInfo?: {
                      orderId?: number;
                      orderNumber?: null | string;
                  };
                  returnOrderInfo?: {
                      comment?: null | string;
                      inDate?: null | string;
                      returnOrderHandlingComment?: null | string;
                      returnOrderId?: number;
                      returnOrderNumber?: null | string;
                      returnOrderStatus?: {
                          number?: number;
                          text?: null | string;
                      };
                      warehouse?: {
                          code?: null | string;
                          id?: number;
                          name?: null | string;
                      };
                  };
                  returnOrderLines?: null | {
                      article?: {
                          articleName?: null | string;
                          articleNumber?: null | string;
                          articleSystemId?: number;
                      };
                      customerOrderLine?: {
                          customerOrderRowNumber?: null | string;
                          orderLineId?: number;
                      };
                      pickedNumberOfItems?: number;
                      returnCause?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      returnOrderLineId?: number;
                      returnOrderRowNumber?: null | string;
                      returnedArticleItems?: null | {
                          articleItemCategory?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          articleItemStatus?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          batch?: null | string;
                          comment?: null | string;
                          container?: null | string;
                          expiryDate?: null | string;
                          isReturnRemovedByInventory?: boolean;
                          numberOfItems?: number;
                          returnCause?: {
                              code?: null | string;
                              name?: null | string;
                          };
                          returnComment?: null | string;
                          returnTime?: null | string;
                          serial?: null | string;
                          volume?: null | number;
                          weight?: null | number;
                      }[];
                      returnedNumberOfItems?: number;
                      returnedRemovedByInventoryNumberOfItems?: number;
                      toBeReturnedNumberOfItems?: number;
                  }[];
              };
          };
      }

      Description

      A return order.

      • content: {
            application/json: {
                customerOrderInfo?: {
                    orderId?: number;
                    orderNumber?: null | string;
                };
                returnOrderInfo?: {
                    comment?: null | string;
                    inDate?: null | string;
                    returnOrderHandlingComment?: null | string;
                    returnOrderId?: number;
                    returnOrderNumber?: null | string;
                    returnOrderStatus?: {
                        number?: number;
                        text?: null | string;
                    };
                    warehouse?: {
                        code?: null | string;
                        id?: number;
                        name?: null | string;
                    };
                };
                returnOrderLines?: null | {
                    article?: {
                        articleName?: null | string;
                        articleNumber?: null | string;
                        articleSystemId?: number;
                    };
                    customerOrderLine?: {
                        customerOrderRowNumber?: null | string;
                        orderLineId?: number;
                    };
                    pickedNumberOfItems?: number;
                    returnCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    returnOrderLineId?: number;
                    returnOrderRowNumber?: null | string;
                    returnedArticleItems?: null | {
                        articleItemCategory?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        articleItemStatus?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        batch?: null | string;
                        comment?: null | string;
                        container?: null | string;
                        expiryDate?: null | string;
                        isReturnRemovedByInventory?: boolean;
                        numberOfItems?: number;
                        returnCause?: {
                            code?: null | string;
                            name?: null | string;
                        };
                        returnComment?: null | string;
                        returnTime?: null | string;
                        serial?: null | string;
                        volume?: null | number;
                        weight?: null | number;
                    }[];
                    returnedNumberOfItems?: number;
                    returnedRemovedByInventoryNumberOfItems?: number;
                    toBeReturnedNumberOfItems?: number;
                }[];
            };
        }
        • application/json: {
              customerOrderInfo?: {
                  orderId?: number;
                  orderNumber?: null | string;
              };
              returnOrderInfo?: {
                  comment?: null | string;
                  inDate?: null | string;
                  returnOrderHandlingComment?: null | string;
                  returnOrderId?: number;
                  returnOrderNumber?: null | string;
                  returnOrderStatus?: {
                      number?: number;
                      text?: null | string;
                  };
                  warehouse?: {
                      code?: null | string;
                      id?: number;
                      name?: null | string;
                  };
              };
              returnOrderLines?: null | {
                  article?: {
                      articleName?: null | string;
                      articleNumber?: null | string;
                      articleSystemId?: number;
                  };
                  customerOrderLine?: {
                      customerOrderRowNumber?: null | string;
                      orderLineId?: number;
                  };
                  pickedNumberOfItems?: number;
                  returnCause?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  returnOrderLineId?: number;
                  returnOrderRowNumber?: null | string;
                  returnedArticleItems?: null | {
                      articleItemCategory?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      articleItemStatus?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      batch?: null | string;
                      comment?: null | string;
                      container?: null | string;
                      expiryDate?: null | string;
                      isReturnRemovedByInventory?: boolean;
                      numberOfItems?: number;
                      returnCause?: {
                          code?: null | string;
                          name?: null | string;
                      };
                      returnComment?: null | string;
                      returnTime?: null | string;
                      serial?: null | string;
                      volume?: null | number;
                      weight?: null | number;
                  }[];
                  returnedNumberOfItems?: number;
                  returnedRemovedByInventoryNumberOfItems?: number;
                  toBeReturnedNumberOfItems?: number;
              }[];
          }
          • Optional customerOrderInfo?: {
                orderId?: number;
                orderNumber?: null | string;
            }
            • Optional orderId?: number

              Format: int32

            • Optional orderNumber?: null | string
          • Optional returnOrderInfo?: {
                comment?: null | string;
                inDate?: null | string;
                returnOrderHandlingComment?: null | string;
                returnOrderId?: number;
                returnOrderNumber?: null | string;
                returnOrderStatus?: {
                    number?: number;
                    text?: null | string;
                };
                warehouse?: {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                };
            }
            • Optional comment?: null | string
            • Optional inDate?: null | string

              Format: date-time

            • Optional returnOrderHandlingComment?: null | string
            • Optional returnOrderId?: number

              Format: int32

            • Optional returnOrderNumber?: null | string
            • Optional returnOrderStatus?: {
                  number?: number;
                  text?: null | string;
              }
              • Optional number?: number

                Format: int32

              • Optional text?: null | string
            • Optional warehouse?: {
                  code?: null | string;
                  id?: number;
                  name?: null | string;
              }
              • Optional code?: null | string
              • Optional id?: number

                Format: int32

              • Optional name?: null | string
          • Optional returnOrderLines?: null | {
                article?: {
                    articleName?: null | string;
                    articleNumber?: null | string;
                    articleSystemId?: number;
                };
                customerOrderLine?: {
                    customerOrderRowNumber?: null | string;
                    orderLineId?: number;
                };
                pickedNumberOfItems?: number;
                returnCause?: {
                    code?: null | string;
                    name?: null | string;
                };
                returnOrderLineId?: number;
                returnOrderRowNumber?: null | string;
                returnedArticleItems?: null | {
                    articleItemCategory?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    articleItemStatus?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    batch?: null | string;
                    comment?: null | string;
                    container?: null | string;
                    expiryDate?: null | string;
                    isReturnRemovedByInventory?: boolean;
                    numberOfItems?: number;
                    returnCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    returnComment?: null | string;
                    returnTime?: null | string;
                    serial?: null | string;
                    volume?: null | number;
                    weight?: null | number;
                }[];
                returnedNumberOfItems?: number;
                returnedRemovedByInventoryNumberOfItems?: number;
                toBeReturnedNumberOfItems?: number;
            }[]
ReturnOrders_GetOrderStatuses: {
    responses: {
        200: {
            content: {
                application/json: {
                    returnOrderStatuses?: null | {
                        number?: number;
                        text?: null | string;
                    }[];
                };
            };
        };
    };
}

Get all return order statuses.

Type declaration

  • responses: {
        200: {
            content: {
                application/json: {
                    returnOrderStatuses?: null | {
                        number?: number;
                        text?: null | string;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  returnOrderStatuses?: null | {
                      number?: number;
                      text?: null | string;
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                returnOrderStatuses?: null | {
                    number?: number;
                    text?: null | string;
                }[];
            };
        }
        • application/json: {
              returnOrderStatuses?: null | {
                  number?: number;
                  text?: null | string;
              }[];
          }
          • Optional returnOrderStatuses?: null | {
                number?: number;
                text?: null | string;
            }[]
ReturnOrders_GetReturnCauses: {
    parameters: {
        query: {
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    returnCauses?: null | {
                        code?: null | string;
                        id?: number;
                        isChangeCause?: boolean;
                        isRemoveCause?: boolean;
                        isReturnCommentMandatory?: boolean;
                        name?: null | string;
                    }[];
                };
            };
        };
    };
}

Get all return causes.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
        };
    }
    • query: {
          goodsOwnerId: number;
      }
      • goodsOwnerId: number
  • responses: {
        200: {
            content: {
                application/json: {
                    returnCauses?: null | {
                        code?: null | string;
                        id?: number;
                        isChangeCause?: boolean;
                        isRemoveCause?: boolean;
                        isReturnCommentMandatory?: boolean;
                        name?: null | string;
                    }[];
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  returnCauses?: null | {
                      code?: null | string;
                      id?: number;
                      isChangeCause?: boolean;
                      isRemoveCause?: boolean;
                      isReturnCommentMandatory?: boolean;
                      name?: null | string;
                  }[];
              };
          };
      }
      • content: {
            application/json: {
                returnCauses?: null | {
                    code?: null | string;
                    id?: number;
                    isChangeCause?: boolean;
                    isRemoveCause?: boolean;
                    isReturnCommentMandatory?: boolean;
                    name?: null | string;
                }[];
            };
        }
        • application/json: {
              returnCauses?: null | {
                  code?: null | string;
                  id?: number;
                  isChangeCause?: boolean;
                  isRemoveCause?: boolean;
                  isReturnCommentMandatory?: boolean;
                  name?: null | string;
              }[];
          }
          • Optional returnCauses?: null | {
                code?: null | string;
                id?: number;
                isChangeCause?: boolean;
                isRemoveCause?: boolean;
                isReturnCommentMandatory?: boolean;
                name?: null | string;
            }[]
ReturnOrders_PutReturnCause: {
    requestBody: {
        content: {
            application/json: {
                code: string;
                goodsOwnerId: number;
                isChangeCause?: null | boolean;
                isRemoveCause?: null | boolean;
                isReturnCommentMandatory?: null | boolean;
                name: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    returnCauseId?: null | number;
                    success?: boolean;
                };
            };
        };
    };
}

Create or update a return cause type. If there is no return cause with the specified code, it will be created. Otherwise, the existing return cause will be updated.

Type declaration

  • requestBody: {
        content: {
            application/json: {
                code: string;
                goodsOwnerId: number;
                isChangeCause?: null | boolean;
                isRemoveCause?: null | boolean;
                isReturnCommentMandatory?: null | boolean;
                name: string;
            };
        };
    }

    Description

    An object containing the return cause data.

    • content: {
          application/json: {
              code: string;
              goodsOwnerId: number;
              isChangeCause?: null | boolean;
              isRemoveCause?: null | boolean;
              isReturnCommentMandatory?: null | boolean;
              name: string;
          };
      }
      • application/json: {
            code: string;
            goodsOwnerId: number;
            isChangeCause?: null | boolean;
            isRemoveCause?: null | boolean;
            isReturnCommentMandatory?: null | boolean;
            name: string;
        }
        • code: string
        • goodsOwnerId: number

          Format: int32

        • Optional isChangeCause?: null | boolean
        • Optional isRemoveCause?: null | boolean
        • Optional isReturnCommentMandatory?: null | boolean
        • name: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    returnCauseId?: null | number;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  returnCauseId?: null | number;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                returnCauseId?: null | number;
                success?: boolean;
            };
        }
        • application/json: {
              message?: null | string;
              returnCauseId?: null | number;
              success?: boolean;
          }
          • Optional message?: null | string
          • Optional returnCauseId?: null | number

            Format: int32

          • Optional success?: boolean
ReturnOrders_PutReturnCauseUsingId: {
    parameters: {
        path: {
            returnCauseId: number;
        };
    };
    requestBody: {
        content: {
            application/json: {
                code: string;
                goodsOwnerId: number;
                isChangeCause?: null | boolean;
                isRemoveCause?: null | boolean;
                isReturnCommentMandatory?: null | boolean;
                name: string;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    returnCauseId?: null | number;
                    success?: boolean;
                };
            };
        };
    };
}

Update a return cause. The ID will be used to identify the return cause.

Type declaration

  • parameters: {
        path: {
            returnCauseId: number;
        };
    }
    • path: {
          returnCauseId: number;
      }
      • returnCauseId: number
  • requestBody: {
        content: {
            application/json: {
                code: string;
                goodsOwnerId: number;
                isChangeCause?: null | boolean;
                isRemoveCause?: null | boolean;
                isReturnCommentMandatory?: null | boolean;
                name: string;
            };
        };
    }

    Description

    An object containing the return cause type data.

    • content: {
          application/json: {
              code: string;
              goodsOwnerId: number;
              isChangeCause?: null | boolean;
              isRemoveCause?: null | boolean;
              isReturnCommentMandatory?: null | boolean;
              name: string;
          };
      }
      • application/json: {
            code: string;
            goodsOwnerId: number;
            isChangeCause?: null | boolean;
            isRemoveCause?: null | boolean;
            isReturnCommentMandatory?: null | boolean;
            name: string;
        }
        • code: string
        • goodsOwnerId: number

          Format: int32

        • Optional isChangeCause?: null | boolean
        • Optional isRemoveCause?: null | boolean
        • Optional isReturnCommentMandatory?: null | boolean
        • name: string
  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    returnCauseId?: null | number;
                    success?: boolean;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  returnCauseId?: null | number;
                  success?: boolean;
              };
          };
      }
      • content: {
            application/json: {
                message?: null | string;
                returnCauseId?: null | number;
                success?: boolean;
            };
        }
        • application/json: {
              message?: null | string;
              returnCauseId?: null | number;
              success?: boolean;
          }
          • Optional message?: null | string
          • Optional returnCauseId?: null | number

            Format: int32

          • Optional success?: boolean
ReturnOrders_PutReturnOrder: {
    requestBody: {
        content: {
            application/json: {
                comment?: null | string;
                customerOrder: {
                    orderId?: number;
                };
                goodsOwnerId: number;
                inDate?: null | string;
                returnOrderHandlingComment?: null | string;
                returnOrderLines: {
                    customerOrderLine: {
                        orderLineId?: number;
                    };
                    returnCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    returnOrderRowNumber: string;
                    toBeReturnedNumberOfItems: number;
                }[];
                returnOrderNumber: string;
                tracking?: null | {
                    trackingUrl?: null | string;
                    waybill?: null | string;
                }[];
                warehouseId?: null | number;
            };
        };
    };
    responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    returnOrderId?: null | number;
                };
            };
        };
    };
}

Create or update a return order.

Type declaration

  • requestBody: {
        content: {
            application/json: {
                comment?: null | string;
                customerOrder: {
                    orderId?: number;
                };
                goodsOwnerId: number;
                inDate?: null | string;
                returnOrderHandlingComment?: null | string;
                returnOrderLines: {
                    customerOrderLine: {
                        orderLineId?: number;
                    };
                    returnCause?: {
                        code?: null | string;
                        name?: null | string;
                    };
                    returnOrderRowNumber: string;
                    toBeReturnedNumberOfItems: number;
                }[];
                returnOrderNumber: string;
                tracking?: null | {
                    trackingUrl?: null | string;
                    waybill?: null | string;
                }[];
                warehouseId?: null | number;
            };
        };
    }

    Description

    The return order.

    • content: {
          application/json: {
              comment?: null | string;
              customerOrder: {
                  orderId?: number;
              };
              goodsOwnerId: number;
              inDate?: null | string;
              returnOrderHandlingComment?: null | string;
              returnOrderLines: {
                  customerOrderLine: {
                      orderLineId?: number;
                  };
                  returnCause?: {
                      code?: null | string;
                      name?: null | string;
                  };
                  returnOrderRowNumber: string;
                  toBeReturnedNumberOfItems: number;
              }[];
              returnOrderNumber: string;
              tracking?: null | {
                  trackingUrl?: null | string;
                  waybill?: null | string;
              }[];
              warehouseId?: null | number;
          };
      }
      • application/json: {
            comment?: null | string;
            customerOrder: {
                orderId?: number;
            };
            goodsOwnerId: number;
            inDate?: null | string;
            returnOrderHandlingComment?: null | string;
            returnOrderLines: {
                customerOrderLine: {
                    orderLineId?: number;
                };
                returnCause?: {
                    code?: null | string;
                    name?: null | string;
                };
                returnOrderRowNumber: string;
                toBeReturnedNumberOfItems: number;
            }[];
            returnOrderNumber: string;
            tracking?: null | {
                trackingUrl?: null | string;
                waybill?: null | string;
            }[];
            warehouseId?: null | number;
        }
        • Optional comment?: null | string
        • customerOrder: {
              orderId?: number;
          }
          • Optional orderId?: number

            Format: int32

        • goodsOwnerId: number

          Format: int32

        • Optional inDate?: null | string

          Format: date-time

        • Optional returnOrderHandlingComment?: null | string
        • returnOrderLines: {
              customerOrderLine: {
                  orderLineId?: number;
              };
              returnCause?: {
                  code?: null | string;
                  name?: null | string;
              };
              returnOrderRowNumber: string;
              toBeReturnedNumberOfItems: number;
          }[]
        • returnOrderNumber: string
        • Optional tracking?: null | {
              trackingUrl?: null | string;
              waybill?: null | string;
          }[]
        • Optional warehouseId?: null | number

          Format: int32

  • responses: {
        200: {
            content: {
                application/json: {
                    message?: null | string;
                    returnOrderId?: null | number;
                };
            };
        };
    }
    • 200: {
          content: {
              application/json: {
                  message?: null | string;
                  returnOrderId?: null | number;
              };
          };
      }

      Description

      A message indicating success or failure.

      • content: {
            application/json: {
                message?: null | string;
                returnOrderId?: null | number;
            };
        }
        • application/json: {
              message?: null | string;
              returnOrderId?: null | number;
          }
          • Optional message?: null | string
          • Optional returnOrderId?: null | number

            Format: int32

TransporterContracts_Get: {
    parameters: {
        query: {
            goodsOwnerId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    ediCode?: null | string;
                    transporterCode?: null | string;
                    transporterName?: null | string;
                    transporterServiceCode?: null | string;
                    transporterServices?: null | {
                        transporterServiceCode?: null | string;
                        transporterServiceName?: null | string;
                    }[];
                }[];
            };
        };
    };
}

Get all transporter contracts for a specific goods owner. The response will include all transporter codes which are available for the goods owner.

Type declaration

  • parameters: {
        query: {
            goodsOwnerId: number;
        };
    }
    • query: {
          goodsOwnerId: number;
      }
      • goodsOwnerId: number

        Description

        Goods owner ID.

  • responses: {
        200: {
            content: {
                application/json: null | {
                    ediCode?: null | string;
                    transporterCode?: null | string;
                    transporterName?: null | string;
                    transporterServiceCode?: null | string;
                    transporterServices?: null | {
                        transporterServiceCode?: null | string;
                        transporterServiceName?: null | string;
                    }[];
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  ediCode?: null | string;
                  transporterCode?: null | string;
                  transporterName?: null | string;
                  transporterServiceCode?: null | string;
                  transporterServices?: null | {
                      transporterServiceCode?: null | string;
                      transporterServiceName?: null | string;
                  }[];
              }[];
          };
      }
      • content: {
            application/json: null | {
                ediCode?: null | string;
                transporterCode?: null | string;
                transporterName?: null | string;
                transporterServiceCode?: null | string;
                transporterServices?: null | {
                    transporterServiceCode?: null | string;
                    transporterServiceName?: null | string;
                }[];
            }[];
        }
        • application/json: null | {
              ediCode?: null | string;
              transporterCode?: null | string;
              transporterName?: null | string;
              transporterServiceCode?: null | string;
              transporterServices?: null | {
                  transporterServiceCode?: null | string;
                  transporterServiceName?: null | string;
              }[];
          }[]
Warehouses_Get: {
    responses: {
        200: {
            content: {
                application/json: null | {
                    address?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        addressFreeText1?: null | string;
                        addressFreeText2?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        name?: null | string;
                        postCode?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                    };
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                }[];
            };
        };
    };
}

Get all warehouses which have been set up in the system.

Type declaration

  • responses: {
        200: {
            content: {
                application/json: null | {
                    address?: {
                        address1?: null | string;
                        address2?: null | string;
                        address3?: null | string;
                        addressFreeText1?: null | string;
                        addressFreeText2?: null | string;
                        city?: null | string;
                        countryCode?: null | string;
                        countryStateCode?: null | string;
                        deliveryInstruction?: null | string;
                        emailNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        name?: null | string;
                        postCode?: null | string;
                        smsNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                        telephoneNotification?: {
                            toBeNotified?: boolean;
                            value?: null | string;
                        };
                    };
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  address?: {
                      address1?: null | string;
                      address2?: null | string;
                      address3?: null | string;
                      addressFreeText1?: null | string;
                      addressFreeText2?: null | string;
                      city?: null | string;
                      countryCode?: null | string;
                      countryStateCode?: null | string;
                      deliveryInstruction?: null | string;
                      emailNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      name?: null | string;
                      postCode?: null | string;
                      smsNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                      telephoneNotification?: {
                          toBeNotified?: boolean;
                          value?: null | string;
                      };
                  };
                  code?: null | string;
                  id?: number;
                  name?: null | string;
              }[];
          };
      }

      Description

      A list of warehouses

      • content: {
            application/json: null | {
                address?: {
                    address1?: null | string;
                    address2?: null | string;
                    address3?: null | string;
                    addressFreeText1?: null | string;
                    addressFreeText2?: null | string;
                    city?: null | string;
                    countryCode?: null | string;
                    countryStateCode?: null | string;
                    deliveryInstruction?: null | string;
                    emailNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    name?: null | string;
                    postCode?: null | string;
                    smsNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                    telephoneNotification?: {
                        toBeNotified?: boolean;
                        value?: null | string;
                    };
                };
                code?: null | string;
                id?: number;
                name?: null | string;
            }[];
        }
        • application/json: null | {
              address?: {
                  address1?: null | string;
                  address2?: null | string;
                  address3?: null | string;
                  addressFreeText1?: null | string;
                  addressFreeText2?: null | string;
                  city?: null | string;
                  countryCode?: null | string;
                  countryStateCode?: null | string;
                  deliveryInstruction?: null | string;
                  emailNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  name?: null | string;
                  postCode?: null | string;
                  smsNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
                  telephoneNotification?: {
                      toBeNotified?: boolean;
                      value?: null | string;
                  };
              };
              code?: null | string;
              id?: number;
              name?: null | string;
          }[]
Warehouses_GetLocationTypes: {
    responses: {
        200: {
            content: {
                application/json: null | {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                }[];
            };
        };
    };
}

Get all location types.

Type declaration

  • responses: {
        200: {
            content: {
                application/json: null | {
                    code?: null | string;
                    id?: number;
                    name?: null | string;
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  code?: null | string;
                  id?: number;
                  name?: null | string;
              }[];
          };
      }

      Description

      A list of location types

      • content: {
            application/json: null | {
                code?: null | string;
                id?: number;
                name?: null | string;
            }[];
        }
        • application/json: null | {
              code?: null | string;
              id?: number;
              name?: null | string;
          }[]
Warehouses_GetZonesForWarehouse: {
    parameters: {
        path: {
            warehouseId: number;
        };
    };
    responses: {
        200: {
            content: {
                application/json: null | {
                    aisles?: null | {
                        id?: number;
                        locations?: null | {
                            barcode?: null | string;
                            id?: number;
                            isLocked?: boolean;
                            isLockedForSale?: boolean;
                            isPickingLocation?: boolean;
                            locationTypeId?: null | number;
                            name?: null | string;
                            pickingPriority?: number;
                            position?: {
                                x?: null | number;
                                y?: null | number;
                                z?: null | number;
                            };
                        }[];
                        name?: null | string;
                        position?: {
                            x?: null | number;
                            y?: null | number;
                        };
                    }[];
                    id?: number;
                    name?: null | string;
                    position?: {
                        x?: null | number;
                        y?: null | number;
                    };
                }[];
            };
        };
    };
}

Get all zones (including aisles and locations) for a particular warehouse.

Type declaration

  • parameters: {
        path: {
            warehouseId: number;
        };
    }
    • path: {
          warehouseId: number;
      }
      • warehouseId: number

        Description

        The warehouse ID

  • responses: {
        200: {
            content: {
                application/json: null | {
                    aisles?: null | {
                        id?: number;
                        locations?: null | {
                            barcode?: null | string;
                            id?: number;
                            isLocked?: boolean;
                            isLockedForSale?: boolean;
                            isPickingLocation?: boolean;
                            locationTypeId?: null | number;
                            name?: null | string;
                            pickingPriority?: number;
                            position?: {
                                x?: null | number;
                                y?: null | number;
                                z?: null | number;
                            };
                        }[];
                        name?: null | string;
                        position?: {
                            x?: null | number;
                            y?: null | number;
                        };
                    }[];
                    id?: number;
                    name?: null | string;
                    position?: {
                        x?: null | number;
                        y?: null | number;
                    };
                }[];
            };
        };
    }
    • 200: {
          content: {
              application/json: null | {
                  aisles?: null | {
                      id?: number;
                      locations?: null | {
                          barcode?: null | string;
                          id?: number;
                          isLocked?: boolean;
                          isLockedForSale?: boolean;
                          isPickingLocation?: boolean;
                          locationTypeId?: null | number;
                          name?: null | string;
                          pickingPriority?: number;
                          position?: {
                              x?: null | number;
                              y?: null | number;
                              z?: null | number;
                          };
                      }[];
                      name?: null | string;
                      position?: {
                          x?: null | number;
                          y?: null | number;
                      };
                  }[];
                  id?: number;
                  name?: null | string;
                  position?: {
                      x?: null | number;
                      y?: null | number;
                  };
              }[];
          };
      }

      Description

      A list of zones

      • content: {
            application/json: null | {
                aisles?: null | {
                    id?: number;
                    locations?: null | {
                        barcode?: null | string;
                        id?: number;
                        isLocked?: boolean;
                        isLockedForSale?: boolean;
                        isPickingLocation?: boolean;
                        locationTypeId?: null | number;
                        name?: null | string;
                        pickingPriority?: number;
                        position?: {
                            x?: null | number;
                            y?: null | number;
                            z?: null | number;
                        };
                    }[];
                    name?: null | string;
                    position?: {
                        x?: null | number;
                        y?: null | number;
                    };
                }[];
                id?: number;
                name?: null | string;
                position?: {
                    x?: null | number;
                    y?: null | number;
                };
            }[];
        }
        • application/json: null | {
              aisles?: null | {
                  id?: number;
                  locations?: null | {
                      barcode?: null | string;
                      id?: number;
                      isLocked?: boolean;
                      isLockedForSale?: boolean;
                      isPickingLocation?: boolean;
                      locationTypeId?: null | number;
                      name?: null | string;
                      pickingPriority?: number;
                      position?: {
                          x?: null | number;
                          y?: null | number;
                          z?: null | number;
                      };
                  }[];
                  name?: null | string;
                  position?: {
                      x?: null | number;
                      y?: null | number;
                  };
              }[];
              id?: number;
              name?: null | string;
              position?: {
                  x?: null | number;
                  y?: null | number;
              };
          }[]

Generated using TypeDoc